Api Docs

---
name: api-docs
description: Create clear, accurate, and comprehensive API documentation.
category: docs
triggers:
  - api
  - documentation
  - reference
  - openapi
version: 0.2.1
---

# API Documentation Skill

## Purpose
Create clear, accurate, and comprehensive API documentation.

## Documentation Components

### 1. Overview
- API purpose and capabilities
- Authentication requirements
- Base URL and versioning
- Rate limits and quotas

### 2. Endpoint Documentation
- HTTP method and path
- Request parameters (path, query, body)
- Request/response examples
- Error responses and codes
- Authentication requirements

### 3. Code Examples
- Multiple language examples (curl, JavaScript, Python)
- Complete, runnable snippets
- Common use case scenarios

## Best Practices

1. **Be Accurate** - Documentation must match actual behavior
2. **Use Examples** - Real request/response pairs
3. **Explain Errors** - Document all error codes and recovery steps
4. **Version Clearly** - Note API version and deprecations
5. **Keep Updated** - Update docs with every API change

## Format Standards

- OpenAPI/Swagger for REST APIs
- GraphQL schema for GraphQL APIs
- JSDoc/TSDoc for library functions