Api Reference Documentation

by secondsky88378361314fMIT227 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 10 days ago

Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. Use when documenting REST APIs, creating SDK references, or building developer portals.

Instructions onlySoftware Development

AI-generated overview

Guides creation of API reference documentation using OpenAPI 3.0 specifications, checklists, and best practices.

What it does: This skill provides instructions for producing API reference documentation for developer integration. It supplies an OpenAPI 3.0 specification example covering servers, security schemes, paths, parameters, and schemas, along with a documentation checklist and best-practice guidance. It also lists documentation tools such as Swagger Editor, Swagger UI, Redoc, Postman, and Stoplight. It ships no scripts and produces no files itself.
When to use it: Use it when documenting REST APIs, creating SDK references, or building developer portals. It fits work that needs endpoint, authentication, error, rate-limit, and pagination coverage in a structured reference.
Requirements: No scripts or packages are required; the skill is instructions only. The tools it mentions, such as Swagger Editor, Swagger UI, Redoc, Postman, and Stoplight, are optional and external.

API Reference Documentation

Create comprehensive API documentation for developer integration.

OpenAPI 3.0 Specification

yaml

openapi: 3.0.3info:  title: E-Commerce API  version: 1.0.0  description: API for managing products and orders  contact:    email: [email protected]
servers:  - url: https://api.example.com/v1    description: Production  - url: https://staging-api.example.com/v1    description: Staging
security:  - bearerAuth: []
paths:  /products:    get:      summary: List products      tags: [Products]      parameters:        - name: limit          in: query          schema: { type: integer, default: 20 }        - name: category          in: query          schema: { type: string }      responses:        '200':          description: Product list          content:            application/json:              schema:                $ref: '#/components/schemas/ProductList'
components:  securitySchemes:    bearerAuth:      type: http      scheme: bearer      bearerFormat: JWT
  schemas:    Product:      type: object      required: [id, name, price]      properties:        id: { type: string, format: uuid }        name: { type: string, maxLength: 200 }        price: { type: number, minimum: 0 }        description: { type: string }

openapi: 3.0.3info:  title: E-Commerce API  version: 1.0.0  description: API for managing products and orders  contact:    email: [email protected]
servers:  - url: https://api.example.com/v1    description: Production  - url: https://staging-api.example.com/v1    description: Staging
security:  - bearerAuth: []
paths:  /products:    get:      summary: List products      tags: [Products]      parameters:        - name: limit          in: query          schema: { type: integer, default: 20 }        - name: category          in: query          schema: { type: string }      responses:        '200':          description: Product list          content:            application/json:              schema:                $ref: '#/components/schemas/ProductList'
components:  securitySchemes:    bearerAuth:      type: http      scheme: bearer      bearerFormat: JWT
  schemas:    Product:      type: object      required: [id, name, price]      properties:        id: { type: string, format: uuid }        name: { type: string, maxLength: 200 }        price: { type: number, minimum: 0 }        description: { type: string }

Documentation Checklist

All endpoints documented with examples
Authentication methods explained
Error responses specified
Rate limits documented
Pagination explained
Webhooks documented (if applicable)
SDK examples in multiple languages

Best Practices

Use OpenAPI 3.0+ specification
Include request/response examples
Document all parameters and headers
Provide authentication examples
Enable interactive API exploration
Maintain version documentation
Include migration guides for breaking changes

Tools

Swagger Editor / Swagger UI
Redoc
Postman Documentation
Stoplight

Source and attribution

Source:secondsky/claude-skillsinplugins/api-reference-documentation/skills/api-reference-documentationat commit8837836

License: MIT

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

Api Reference Documentation

API Reference Documentation

OpenAPI 3.0 Specification

Documentation Checklist

Best Practices

Tools

Source and attribution

More from secondsky/claude-skills

Vulnerability Scanning

Web Performance Optimization

Web Performance Audit

Threejs

Tailwind V4 Shadcn

Technical Specification

More in Software Development

Playground

M5 Onboard

Cardputer Buddy

Web Design Guidelines

Vercel React Native Skills

Vercel React Best Practices