API Documentation

Use when generating OpenAPI / Swagger specs, writing API references, or formatting markdown developer portals.

Drvivek34 4f8c705 2 files · 1.0 KB Updated

File contents

API Documentation Instructions

  1. Analyze HTTP endpoint routers and controllers in source code.
  2. Draft paths, methods, parameters, and query shapes.
  3. Write clean OpenAPI 3.0 YAML or JSON specs.
  4. Generate mock responses for 200 OK and error scenarios (400, 401, 404, 500).
  5. Create markdown guides explaining authentication and pagination.

Drvivek34/Skill-Bazaar/tree/main/documentation/api-documentation commit 4f8c705b12

Frequently asked questions

npx skillmds@latest add drvivek34/api-documentation