Engineering/Engineering Principles/2 Quality/REST APIs/REST API Documentation/

REST API Documentation Standards · REST-01

REST APIs must be documented using the OpenAPI standard · REST-01.1 · MUST · DEV

The following things must be included in the documentation:

  • Request types
  • Response types
  • Response codes