Skip to content
This repository was archived by the owner on Nov 2, 2024. It is now read-only.

API_Documentation.md

Latest commit

 

History

History
5 lines (4 loc) · 331 Bytes

API_Documentation.md

File metadata and controls

5 lines (4 loc) · 331 Bytes

API Documentation

  • Use OpenAPI documentation for all public APIs.
  • Having OpenAPI documentation for internal APIs is preferable.
  • Test implementation against API sepcification using OpenAPI validators such as league/openapi-psr7-validator. This helps ensure our documentation doesn't get left behind when changes are made.