Architectural Design Patterns · Example Payload

Architectural Design Patterns Api Pattern Example

Design PatternsSoftware ArchitectureBest PracticesSoftware EngineeringSystem DesignMicroservices

Architectural Design Patterns Api Pattern Example is an example object payload from Architectural Design Patterns, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

$schemaexample

Example Payload

Raw ↑ 
{
  "$schema": "https://raw.githubusercontent.com/api-evangelist/architectural-design-patterns/refs/heads/main/json-schema/architectural-design-patterns-api-pattern-schema.json",
  "example": {
    "id": "example-string",
    "name": "example-string",
    "category": "example-string",
    "description": "example-string",
    "problem": "example-string",
    "solution": "example-string",
    "consequences": [
      "example-string"
    ],
    "tags": [
      "example-string"
    ],
    "relatedPatterns": [
      "example-string"
    ],
    "applicability": "example-string",
    "knownUses": [
      "example-string"
    ]
  }
}