api-reference-documentation

Solid

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.

API & Backend 168 stars 27 forks Updated 4 weeks ago MIT

Install

View on GitHub

Quality Score: 87/100

Stars 20%
74
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
98
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# API Reference Documentation Create comprehensive API documentation for developer integration. ## OpenAPI 3.0 Specification ```yaml openapi: 3.0.3 info: title: E-Commerce API version: 1.0.0 description: API for managing products and orders contact: email: api@example.com 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...

Details

Author
secondsky
Repository
secondsky/claude-skills
Created
7 months ago
Last Updated
4 weeks ago
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category