mcpField
A
api-reference-documentation

api-reference-documentation

github.com/secondskyDevelopment240460 installsUpdated 5w ago
Repository

About api-reference-documentation

A skill for creating API reference documentation, with guidance on OpenAPI specifications, endpoint details, examples, and maintenance. It is intended for developers documenting APIs for integration.

Key features

  1. 01OpenAPI 3.0 specification guidance
  2. 02Endpoint and parameter checklist
  3. 03Request and response examples
  4. 04Authentication and error documentation
  5. 05Versioning and migration guidance
  6. 06Interactive exploration tool suggestions

Use cases

  1. 01Documenting an API for developer integration
  2. 02Checking endpoint reference completeness
  3. 03Explaining authentication and error responses
  4. 04Preparing documentation for breaking changes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/secondsky/claude-skills --skill api-reference-documentation

After installing, type/api-reference-documentationin Claude Code to confirm it loaded.

Details

From the project README

API Reference Documentation

Create comprehensive API documentation for developer integration.

OpenAPI 3.0 Specification

openapi: 3.0.3
info:
  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

Comments

Markdown supported