documentation-create-api

A set of instructions for documenting an API, the interface that lets software systems communicate with each other. It covers available endpoints, authentication, data formats, and usage examples using the OpenAPI standard.

In plain words
What is it for?
Use it to inspect API routes, create an OpenAPI 3.0 specification, document authentication, and write integration guides with code examples.
Why use it?
It gives developers a consistent reference for connecting to an API without having to discover its behavior from source code alone.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/oakensoul/nextjs-cursor-prompts/documentation-create-api
Clone the repo
git clone --depth 1 https://github.com/oakensoul/nextjs-cursor-prompts

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 6,642 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.06642
Opus 5 $0.00000 $0.03321
Sonnet 5 $0.00000 $0.01328
Haiku 4.5 $0.00000 $0.00664

Measured 2d ago against content hash d1cdc6cf974d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-create-api scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

const apiClient = axios.create({
.cursor/prompts/documentation/documentation-create-api.mdc · 1,050 lines

How it starts

The opening of the file, as written. The whole thing — 1,050 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API Documentation Creation and Generation

This prompt generates comprehensive API documentation including endpoint specifications, authentication flows, integration examples, and developer guides with proper OpenAPI standards.

🎯 API DOCUMENTATION OBJECTIVES:

  1. ANALYZE existing API structure and extract complete endpoint specifications
  2. GENERATE OpenAPI 3.0 specification with comprehensive schemas and examples
  3. CREATE integration guides with practical code examples in multiple languages
  4. DOCUMENT authentication flows with security considerations and examples
  5. ESTABLISH maintenance processes for keeping documentation current with code changes

🔍 API DISCOVERY AND ANALYSIS:

STEP 1: API Endpoint Discovery

Automated Endpoint Detection:
# Discover API endpoints across the codebase
echo "🔍 Discovering API endpoints..."

# Next.js API routes discovery
if [ -d "src/app/api" ] || [ -d "app/api" ] || [ -d "pages/api" ]; then
    echo "## Next.js API Routes:"
    find . -path "*/api/*" -name "*.ts" -o -name "*.js" | grep -E "(route|api)" | sort
fi

# Express.js routes discovery
echo -e "\n## Express/Node.js Routes:"
grep -r "app\.\(get\|post\|put\|delete\|patch\)" --include="*.ts" --include="*.js" src/ 2>/dev/null | head -20

# FastAPI/Python routes (if applicable)
echo -e "\n## Python API Routes:"
grep -r "@app\.\(get\|post\|put\|delete\|patch\)" --include="*.py" . 2>/dev/null | head -10

# GraphQL schema discovery
echo -e "\n## GraphQL Schema:"
find . -name "*.graphql" -o -name "schema.ts" -o -name "typeDefs.ts" | head -10

# API middleware and authentication
echo -e "\n## Authentication Middleware:"
grep -r "auth\|jwt\|token" --include="*.ts" --include="*.js" src/ | grep -E "(middleware|auth)" | head -10
API Structure Analysis:
# Analyze API structure and patterns
echo "📊 Analyzing API structure..."

# Check for OpenAPI/Swagger existing docs
echo "## Existing API Documentation:"
find . -name "swagger*" -o -name "openapi*" -o -name "api-docs*" | head -10

# Analyze request/response patterns
echo -e "\n## Request/Response Patterns:"
grep -r "Request\|Response" --include="*.ts" src/ | grep -E "(interface|type)" | head -10

# Database models (for API data structures)
echo -e "\n## Data Models:"
find . -name "*.model.ts" -o -name "*.schema.ts" -o -name "prisma.schema" | head -10

# API versioning strategy
echo -e "\n## API Versioning:"
grep -r "v1\|v2\|version" --include="*.ts" --include="*.js" src/ | grep -i api | head -5

Read the full file on GitHub · 1,050 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 1,050 lines · 0 tokens per session scan A d1cdc6cf974d

Subscribe to this mod's changes

documentation-create-api is a cursor rule published in the GitHub repository oakensoul/nextjs-cursor-prompts (4 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 6,642 tokens. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.