# Generate Api Docs

> Generate API documentation from code

- **Type:** Skill
- **Install:** `agentstack add skill-emaraschio-cursor-commands-generate-api-docs`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [emaraschio](https://agentstack.voostack.com/s/emaraschio)
- **Installs:** 0
- **Category:** [Developer Tools](https://agentstack.voostack.com/c/developer-tools)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [emaraschio](https://github.com/emaraschio)
- **Source:** https://github.com/emaraschio/cursor-commands/tree/main/.cursor/skills/generate-api-docs
- **Website:** https://github.com/emaraschio/cursor-commands#readme

## Install

```sh
agentstack add skill-emaraschio-cursor-commands-generate-api-docs
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

## Overview

Create comprehensive API documentation for the current endpoints formatted as OpenAPI/Swagger specification or following the project's documentation standards.

## Steps

1. **API Overview**
    - Service description and purpose
    - Base URL and versioning information
    - Authentication and authorization requirements
    - Rate limiting and usage policies
2. **Endpoint Documentation**
    - HTTP method and URL path
    - Request parameters (path, query, body)
    - Request/response schemas with data types
    - Example requests and responses
    - Possible error codes and messages
3. **Data Models**
    - Define all data models and schemas
    - Include field descriptions and constraints
    - Show relationships between models
    - Provide example payloads
4. **Usage Examples**
    - Common use case scenarios
    - SDK and client library examples
    - CURL command examples
    - Error handling examples

## API Documentation Checklist

- [ ] API overview complete
- [ ] Endpoints documented
- [ ] Data models defined
- [ ] Usage examples provided
- [ ] Documentation formatted per project standards

## Guardrails

- Document only endpoints that exist in code; do not invent endpoints, parameters, or responses.
- Use placeholder values in examples; never expose real secrets or credentials.

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [emaraschio](https://github.com/emaraschio)
- **Source:** [emaraschio/cursor-commands](https://github.com/emaraschio/cursor-commands)
- **License:** MIT
- **Homepage:** https://github.com/emaraschio/cursor-commands#readme

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** yes
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-emaraschio-cursor-commands-generate-api-docs
- Seller: https://agentstack.voostack.com/s/emaraschio
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.
