Documentation API Documentation Best Practices

Imported TRAE skill from documentation/API_Documentation_Best_Practices.md Use when this capability is needed.

tomevault-io 370910b 2 files · 1.7 KB Updated

File contents

API Documentation Best Practices

Overview

Good API documentation is essential for developer experience and adoption.

Tools

  • Swagger/OpenAPI: Standard for REST APIs. Auto-generate from code where possible.
  • Postman Collections: Shareable request collections.
  • GraphiQL/Apollo Studio: For GraphQL APIs.

Content

  • Authentication: How to authenticate (Bearer, API Key).
  • Endpoints: Method, URL, Parameters.
  • Request/Response Examples: JSON bodies for success and error cases.
  • Error Codes: Explain standard error responses.

Source: Ditto190/crispy-nextjs-turborepo-monorepo — distributed by TomeVault.

tomevault-io/skills-registry/tree/main/ditto190--crispy-nextjs-turborepo-monorepo--documentation-api-documentation-best-practices commit 370910bf14

Frequently asked questions

npx skillmds@latest add tomevault-io/documentation-api-documentation-best-practices