Skip to content

Getting API requirements

Entity relationship diagram

erDiagram
  API-REQUIREMENTS-VERSION ||--o{ API-REQUIREMENT : contains

Info

  • Exactly one API-REQUIREMENTS-VERSION contains zero or more API-REQUIREMENT

Get API requirements

List all must-have requirements for API specifications with the REST architectural style:

GET https://api.zorgapis.nl/v1beta1/api-requirements-versions/1.2.0/api-requirements
    ?filter=and(
        eq(requirementLevel,"MUST"), // (1)!
        any(perspectiveTypes,eq($it,"API_SPECIFICATION")), // (2)!
        any(architecturalStyles,eq($it,"REST")), // (3)!
    ) HTTP/1.1
  1. The requirement level must be equal to "MUST".
  2. The perspective types must include "API_SPECIFICATION".
  3. The architectural styles must include "REST".
HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "516033cb-06a4-4312-8874-dfbed689760f", // (1)!
    "code": "SD001",
    "description": "API documentation MUST be publicly and freely available",
    "url": "https://nictiz.github.io/api-requirements-docs/v1.2.0/api-specification-and-documentation/#sd001-api-documentation-must-be-publicly-and-freely-available",
    "requirementLevel": "MUST",
    "score": 1,
    "category": "API_SPECIFICATION_AND_DOCUMENTATION",
    "roles": [ // (2)!
      "API_SPECIFIER"
    ],
    "perspectiveTypes": [ // (3)!
      "API_SPECIFICATION"
    ],
    "architecturalStyles": [ // (4)!
      "REST",
      "SOAP",
      "GRAPHQL",
      "ODATA",
      "GRPC",
      "OTHER"
    ],
    "standardizationLevels": [ // (5)!
      "OPEN_API",
      "TECHNICALLY_STANDARDIZED_API",
      "FULLY_STANDARDIZED_API"
    ]
  },
  ...
]
  1. The Universally Unique Identifier, or UUID (see RFC 4122), assigned to the API requirement by the API server.
  2. The roles that apply to the API requirement.
  3. The perspective types that apply to the API requirement.
  4. The architectural styles that apply to the API requirement.
  5. The standardization levels that apply to the API requirement.

Note

To learn more, view the API reference or fork our Postman Collection and explore our API.