Generates OpenAPI specifications and endpoint documentation templates for REST APIs.
npx skills add https://github.com/jvsandhu/agentic-skills --skill docs-api-jvsandhu
Please help me install this Agent Skill. Skill: docs_api Source: https://github.com/jvsandhu/agentic-skills/tree/main/skills/docs_api Command: npx skills add https://github.com/jvsandhu/agentic-skills --skill docs-api-jvsandhu
$ref. - Endpoint Documentation Templates: Standardized Markdown templates covering request fields, success responses, and error codes. - Three-Phase Workflow: Guides design (mocking with prism, linting with spectral), documentation (descriptions, examples, auth schemes), and publication (redoc-cli bundling, versioning). - Use Case: When building a new REST API, use this Skill to draft the OpenAPI spec first, lint it with spectral, then generate static HTML docs with redoc-cli before writing any backend code. ## Quick Start Create an OpenAPI 3.0 specification for my user management API with endpoints for listing and creating users, including error response examples.High-intent search queries and answers about installing and using this skill.
Start with the OpenAPI 3.0.3 template defining info, paths, and components sections. Mock the API with prism or stoplight before coding, then lint the spec with spectral to enforce standards like CamelCase and required descriptions.
Use redoc-cli bundle or swagger-cli to convert your OpenAPI YAML file into static HTML documentation. Verify the generated docs by testing the Try it out feature and confirming all required fields are marked in schemas.
Spectral is the recommended linter for auditing OpenAPI files against style rules such as naming conventions and mandatory descriptions. Run spectral lint openapi.yaml and confirm it passes without errors before publication.
Yes, split large specs into components using $ref references such as components/schemas/User.yaml instead of maintaining one giant file. This improves maintainability and enables schema reuse across endpoints.
Include examples for both successful responses and error responses covering 4xx and 5xx status codes. Document error codes like VALIDATION_ERROR with their response structure, and clearly define security schemes such as Bearer or OAuth2.
eleva-labsGenerate backend API scaffolding from OpenAPI, Swagger, or GraphQL specifications.
Jet-labsGenerate OpenAPI 3.1+ and AsyncAPI specs with interactive documentation.
btabaskaGenerate contract tests validating API endpoints against OpenAPI and TypeScript types.
JEO-tech-aiGenerate OpenAPI/Swagger-compatible API documentation from definitions, schemas, and annotations.