Document REST endpoints with request/response schemas and error codes.
npx skills add https://github.com/LerianStudio/ring --skill writing-api-docs
Please help me install this Agent Skill. Skill: writing-api-docs Source: https://github.com/LerianStudio/ring/tree/main/tw-team/skills/writing-api-docs Command: npx skills add https://github.com/LerianStudio/ring --skill writing-api-docs
Patterns and structure for writing API reference documentation including endpoint descriptions, request/response schemas, and error documentation.
Write API docs for a new endpoint: /writing-api-docs write-endpoint.
High-intent search queries and answers about installing and using this skill.
API endpoint documentation should include the HTTP method, resource path, description of what the endpoint does, request parameters with types, response schema with field definitions, and standard error codes. This structure ensures consistent, reusable patterns across all endpoints in your REST API.
Request and response schemas must specify field names, data types, required vs. optional fields, and field descriptions. For responses, include the HTTP status code and example JSON. This ensures developers understand exactly what data to send and expect back.
API error documentation should define error codes, HTTP status codes, error messages, and when each error occurs. Use a consistent JSON error schema across all endpoints so developers can handle failures predictably.
Yes. These documentation patterns and structures apply to both new API references and updating existing documentation. They ensure consistency when adding endpoints or revising schemas in live APIs.
API documentation should include explicit versioning—either in the URL path (/v1/, /v2/) or header—and document how versions differ. This clarifies which endpoints and schemas apply to each version for your users.
OneWave-AIGenerate OpenAPI/Swagger specs and endpoint documentation for REST, GraphQL, WebSocket, and gRPC APIs.
herdiansahCreate OpenAPI 3.1 specifications and generate interactive developer portals.
eleva-labsValidate API implementations against OpenAPI specifications and contracts.
wfukatsuGenerate REST, GraphQL, gRPC, and AsyncAPI specifications for microservices.
