Afrexai Api Docs

# API Documentation Generator

Generate production-ready API documentation from endpoint descriptions. Outputs OpenAPI 3.0, markdown reference docs, and SDK quickstart guides.

## Usage

Describe your API endpoints and this skill generates:

1. **OpenAPI 3.0 spec** — machine-readable, import into Swagger/Postman
2. **Markdown reference** — human-readable endpoint docs with examples
3. **SDK quickstart** — copy-paste integration guide for developers

## Instructions

When the user describes API endpoints (routes, methods, parameters, responses):

1. Generate a complete OpenAPI 3.0 YAML specification
2. Create markdown documentation with:
   - Authentication section
   - Each endpoint: method, path, description, parameters table, request/response examples
   - Error codes reference
   - Rate limiting notes
3. Generate a quickstart guide with curl examples and common language snippets (Python, JavaScript, Go)

### Output Format

```yaml
# openapi.yaml — full OpenAPI 3.0 spec
```

```markdown
# API Reference — human-readable docs
```

```markdown
# Quickstart Guide — integration examples
```

### Quality Standards
- Every endpoint must have request AND response examples
- Use realistic sample data, not "string" or "example"
- Include error responses (400, 401, 403, 404, 500)
- Document pagination, filtering, and sorting patterns
- Note breaking changes and versioning strategy

## Tips
- Paste your route files or controller code for automatic extraction
- Works with REST, GraphQL (schema-first), and gRPC (proto-first)
- Combine with CI/CD to auto-generate docs on every deploy

---

Built by [AfrexAI](https://afrexai-cto.github.io/context-packs/) — AI-powered business tools for teams that ship fast.

# API Documentation Generator

Stop writing API docs by hand. Describe your endpoints and get production-ready OpenAPI specs, markdown references, and SDK quickstarts in seconds.

## What You Get

- **OpenAPI 3.0 YAML** — import directly into Swagger UI, Postman, or Redoc
- **Markdown reference docs** — every endpoint with params, examples, error codes
- **Quickstart guides** — curl + Python + JavaScript + Go snippets ready to copy

## Why This Exists

Engineering teams spend 4-8 hours per sprint on documentation. Most API docs are outdated within a week of writing them. This skill generates complete, consistent docs from endpoint descriptions — no more excuses for missing documentation.

## Works With

- REST APIs (any framework)
- GraphQL (schema-first generation)
- gRPC (proto-first generation)

## Install

```bash
clawhub install afrexai-api-docs
```

## Example

Tell your agent: "Document my user API: GET /users, POST /users, GET /users/:id, PUT /users/:id, DELETE /users/:id"

You'll get a complete OpenAPI spec, formatted reference docs, and integration quickstart — all consistent, all with realistic examples.

---

## More from AfrexAI

- [AI Revenue Leak Calculator](https://afrexai-cto.github.io/ai-revenue-calculator/) — find where you're bleeding money on manual processes
- [AI Agent Setup Wizard](https://afrexai-cto.github.io/agent-setup/) — deploy your first AI agent in 15 minutes
- [Context Packs](https://afrexai-cto.github.io/context-packs/) — industry-specific AI configurations ($47/pack)

Built by [AfrexAI](https://afrexai-cto.github.io/context-packs/) 🖤💛