{
  "id": "bbg-p0143-api-gateways-and-contracts-api",
  "title": "REST API Design Practices",
  "chapter": "api-gateways-and-contracts",
  "batch": "04",
  "rank": 32,
  "sourcePage": 143,
  "sourcePointer": "p. 143",
  "status": "accepted",
  "reviewerStatus": "reviewed",
  "fidelityScore": 0.9,
  "canvas": {
    "width": 960,
    "height": 640
  },
  "fireworksTechGraph": {
    "style": "style-1-flat-icon",
    "diagramType": "architecture",
    "topologyNotes": [
      "source page render inspected",
      "extracted page text inspected",
      "source page render inspected",
      "preserve API design practices: clear resources, idempotency, pagination, sorting, references, rate limits, versioning, security, and stable errors",
      "omit source branding, product icons, and copied checklist prose"
    ],
    "publicBoundary": [
      "original vector output",
      "no source pixels",
      "no source mark or long wording"
    ]
  },
  "callouts": [],
  "sourceReview": {
    "conceptAnchors": [
      "concept: clear resource naming",
      "concept: idempotency",
      "concept: pagination",
      "concept: versioning",
      "concept: API security"
    ],
    "labelSource": "curated",
    "semanticStatus": "reviewed"
  },
  "groups": [
    {
      "id": "contract",
      "label": "Contract shape",
      "x": 56,
      "y": 122,
      "w": 266,
      "h": 326
    },
    {
      "id": "behavior",
      "label": "Behavior controls",
      "x": 350,
      "y": 122,
      "w": 258,
      "h": 326
    },
    {
      "id": "operations",
      "label": "Operational controls",
      "x": 636,
      "y": 122,
      "w": 266,
      "h": 326
    }
  ],
  "shapes": [
    {
      "id": "names",
      "kind": "rect",
      "label": "Clear names",
      "detail": "resources",
      "x": 92,
      "y": 164,
      "w": 128,
      "h": 58,
      "tone": "blue"
    },
    {
      "id": "verbs",
      "kind": "rect",
      "label": "HTTP verbs",
      "detail": "intent",
      "x": 92,
      "y": 270,
      "w": 128,
      "h": 58,
      "tone": "teal"
    },
    {
      "id": "errors",
      "kind": "rect",
      "label": "Stable errors",
      "detail": "codes shape",
      "x": 92,
      "y": 376,
      "w": 128,
      "h": 58,
      "tone": "gray"
    },
    {
      "id": "idem",
      "kind": "rect",
      "label": "Idempotency",
      "detail": "safe retry",
      "x": 386,
      "y": 170,
      "w": 128,
      "h": 58,
      "tone": "purple"
    },
    {
      "id": "pages",
      "kind": "rect",
      "label": "Pagination",
      "detail": "bounded lists",
      "x": 386,
      "y": 282,
      "w": 128,
      "h": 58,
      "tone": "green"
    },
    {
      "id": "filter",
      "kind": "rect",
      "label": "Sort filter",
      "detail": "query params",
      "x": 386,
      "y": 386,
      "w": 128,
      "h": 58,
      "tone": "orange"
    },
    {
      "id": "limit",
      "kind": "rect",
      "label": "Rate limits",
      "detail": "availability",
      "x": 674,
      "y": 170,
      "w": 128,
      "h": 58,
      "tone": "red"
    },
    {
      "id": "version",
      "kind": "rect",
      "label": "Versioning",
      "detail": "compatibility",
      "x": 674,
      "y": 282,
      "w": 128,
      "h": 58,
      "tone": "blue"
    },
    {
      "id": "security",
      "kind": "rect",
      "label": "Security",
      "detail": "authz authn",
      "x": 674,
      "y": 386,
      "w": 128,
      "h": 58,
      "tone": "purple"
    }
  ],
  "connectors": [
    {
      "from": "names",
      "to": "verbs",
      "label": "address",
      "flow": "main"
    },
    {
      "from": "verbs",
      "to": "errors",
      "label": "respond",
      "flow": "data"
    },
    {
      "from": "errors",
      "to": "idem",
      "label": "retry",
      "flow": "control"
    },
    {
      "from": "idem",
      "to": "pages",
      "label": "lists",
      "flow": "main"
    },
    {
      "from": "pages",
      "to": "filter",
      "label": "narrow",
      "flow": "data"
    },
    {
      "from": "filter",
      "to": "limit",
      "label": "load",
      "flow": "control"
    },
    {
      "from": "limit",
      "to": "version",
      "label": "change",
      "flow": "control"
    },
    {
      "from": "version",
      "to": "security",
      "label": "protect",
      "flow": "control"
    }
  ]
}