skills.rest
aicodepro
aicodeproOFFICIAL
Explore all skills by this author →
GitHub

api-reference-documentation

Creates OpenAPI 3.0 specifications and API reference documentation for REST endpoints.

Updated Jun 22, 2026
Search Tags:#openapi#swagger#rest api#api documentation#developer portal#sdk reference#redoc
One-click install
npx skills add https://github.com/aicodepro/ai-agent-nexi --skill api-reference-documentation-aicodepro
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-reference-documentation
Source: https://github.com/aicodepro/ai-agent-nexi/tree/main/agent/skills/api-reference-documentation
Command: npx skills add https://github.com/aicodepro/ai-agent-nexi --skill api-reference-documentation-aicodepro

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, complete API documentation is time-consuming, and missing details like authentication, error responses, or rate limits frustrate developers integrating with your API. ## Core Features & Use Cases - OpenAPI 3.0 Specification Templates: Provides a complete spec skeleton covering servers, security schemes, paths, parameters, and reusable schemas. - Documentation Checklist: Ensures endpoints, authentication, error responses, rate limits, pagination, and webhooks are all documented. - Tooling Guidance: Recommends Swagger UI, Redoc, Postman, and Stoplight for rendering interactive documentation. - Use Case: You are launching a public REST API for an e-commerce platform and need a developer portal with endpoint references, JWT authentication examples, and SDK snippets before release. ## Quick Start Ask the assistant to generate OpenAPI 3.0 reference documentation for your REST API endpoints, including authentication and request/response examples.

Frequently Asked Questions about api-reference-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write API documentation with OpenAPI 3.0?▼

Define an OpenAPI 3.0 YAML file with info, servers, paths, and components sections describing each endpoint's parameters and responses. Render it interactively with Swagger UI or Redoc so developers can explore and test requests.

What should REST API reference documentation include?▼

Complete API documentation covers all endpoints with examples, authentication methods, error responses, rate limits, pagination, and webhooks where applicable. Including SDK examples in multiple languages improves developer adoption.

Swagger UI vs Redoc for API documentation?▼

Swagger UI offers interactive try-it-out consoles for testing endpoints directly, while Redoc focuses on clean, readable three-column reference layouts. Both render standard OpenAPI 3.0 specifications, so you can switch without rewriting docs.

How do I document JWT authentication in OpenAPI?▼

Define a securitySchemes entry under components with type http, scheme bearer, and bearerFormat JWT, then apply it globally via a top-level security array. Each endpoint then automatically inherits the bearer token requirement.

When should I version my API documentation?▼

Maintain versioned documentation whenever you introduce breaking changes such as removed fields or altered response formats. Include migration guides so existing integrators can upgrade without guesswork.

Related Skills

Explore More Software Engineering Skills→
mahg-esmahg-es
3

api-design

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Official
Advanced
dinoudondinoudon

api-documentation

Generates API references and SDK scaffolds from OpenAPI specifications.

Community
Advanced
eleva-labseleva-labs

api-validate

Validate API implementations against OpenAPI specifications and contracts.

Official
Intermediate
EngineerWithAIEngineerWithAI
4

openapi-spec-generation

Generate, maintain, and validate OpenAPI 3.1 specifications for RESTful APIs.

Official
Advanced