api-documenter

Included with Lifetime

$97 forever

Generate API documentation: OpenAPI 3.1 specs, interactive docs with Swagger/Redoc, SDK generation, and JSDoc/TSDoc extraction.

Backend & APIs

What this skill does


# API Documentation

Generate and maintain API documentation from code and OpenAPI specs.

## OpenAPI Spec Validation

```bash
# Validate an OpenAPI spec
npx @apidevtools/swagger-cli validate openapi.yaml

# Bundle split spec files into one
npx @apidevtools/swagger-cli bundle openapi.yaml -o openapi-bundled.yaml
```

## Interactive Docs

### Swagger UI

```bash
# Serve Swagger UI locally
npx @redocly/cli preview openapi.yaml

# Or with Docker
docker run -p 8080:8080 -e SWAGGER_JSON=/spec/openapi.yaml -v $(pwd):/spec swaggerapi/swagger-ui
```

### Redoc

```bash
# Generate static HTML docs
npx @redocly/cli build-docs openapi.yaml -o docs.html

# Preview with hot reload
npx @redocly/cli preview-docs openapi.yaml
```

## Generate OpenAPI from Code

### Express/Node.js with swagger-jsdoc

```bash
# Install
npm install swagger-jsdoc swagger-ui-express

# Generate spec from JSDoc annotations
node -e "
const swaggerJsdoc = require('swagger-jsdoc');
const spec = swaggerJsdoc({
  definition: { openapi: '3.1.0', info: { title: 'My API', version: '1.0.0' } },
  apis: ['./src/routes/*.ts'],
});
console.log(JSON.stringify(spec, null, 2));
" > openapi.json
```

### FastAPI (Python — auto-generates)

```bash
# FastAPI generates OpenAPI automatically at /docs
# Export the spec:
curl -s http://localhost:8000/openapi.json | jq . > openapi.json
```

## TypeDoc (TypeScript Documentation)

```bash
# Generate docs from TypeScript
npx typedoc --entryPoints src/index.ts --out docs/api

# JSON output
npx typedoc --json docs/api.json --entryPoints src/index.ts

# With README
npx typedoc --entryPoints src/index.ts --out docs/api --readme README.md
```

## JSDoc Extraction

```bash
# Generate HTML docs from JSDoc comments
npx jsdoc src/ -r -d docs/

# With custom template
npx jsdoc src/ -r -d docs/ -t node_modules/clean-jsdoc-theme
```

## SDK Generation from OpenAPI

```bash
# Generate TypeScript client
npx openapi-typescript openapi.yaml -o src/api-types.ts

# Generate full SDK with openapi-generator
npx @openapitools/openapi-generator-cli generate \
  -i openapi.yaml \
  -g typescript-fetch \
  -o src/generated/api

# Python client
npx @openapitools/openapi-generator-cli generate \
  -i openapi.yaml \
  -g python \
  -o generated/python-client
```

## Linting OpenAPI Specs

```bash
# Redocly lint
npx @redocly/cli lint openapi.yaml

# Spectral (custom rules)
npx @stoplight/spectral-cli lint openapi.yaml
```

## Notes

- Write the OpenAPI spec first (design-first), then implement. It's faster than code-first for teams.
- Keep specs in version control alongside the code.
- Validate specs in CI — broken docs are worse than no docs.
- SDK generation saves client teams significant time. Regenerate on every API change.
- Use `$ref` to split large specs into manageable files.

Files: 1

Size: 3.0 KB

Complexity: 11/100

Category: Backend & APIs

Source: https://github.com/thinkfleetai/thinkfleet-engine/tree/main/skills/api-documenter

Related in Backend & APIs

jfrog

Included

Interact with the JFrog Platform via the JFrog CLI and REST/GraphQL APIs. Use this skill when the user wants to manage Artifactory repositories, upload or download artifacts, manage builds, configure permissions, manage users and groups, work with access tokens, configure JFrog CLI servers, search artifacts, manage properties, set up replication, manage JFrog Projects, run security audits or scans, look up CVE details, query exposures scan results from JFrog Advanced Security, manage release bundles and lifecycle operations, aggregate or export platform data, or perform any JFrog Platform administration task. Also use when the user mentions jf, jfrog, artifactory, xray, distribution, evidence, apptrust, onemodel, graphql, workers, mission control, curation, advanced security, exposures, or any JFrog product name.

Backend & APIsscripts

cupynumeric-migration-readiness

Included

Pre-migration readiness assessor for porting NumPy to cuPyNumeric. Use BEFORE substantial porting work begins when the user asks whether code will scale on GPU, whether they should migrate to cuPyNumeric, which NumPy patterns transfer cleanly, what must be refactored before porting, or mentions pre-port assessment, scaling analysis, or refactor planning. Inspect the user's source code, look up NumPy usage, cross-reference the cuPyNumeric API support manifest, and distinguish distributed-scaling-friendly patterns from blockers such as unsupported APIs, scalar synchronization, host round-trips, Python/object-heavy control flow, shape/data-dependent branching, and in-place mutation hazards. Produce a verdict of READY, LIGHT REFACTOR, SIGNIFICANT REFACTOR, or NOT RECOMMENDED, with concrete refactor pointers.

Backend & APIsscripts

alibabacloud-data-agent-skill

Included

Invoke Alibaba Cloud Apsara Data Agent for Analytics via CLI to perform natural language-driven data analysis on enterprise databases. Data Agent for Analytics is an intelligent data analysis agent developed by Alibaba Cloud Database team for enterprise users. It automatically completes requirement analysis, data understanding, analysis insights, and report generation based on natural language descriptions. This tool supports: discovering data resources (instances/databases/tables) managed in DMS, initiating query or deep analysis sessions, real-time progress tracking, and retrieving analysis conclusions and generated reports. Use this Skill when users need to query databases, analyze data trends, generate data reports, ask questions in natural language, or mention "Data Agent", "data analysis", "database query", "SQL analysis", "data insights".

Backend & APIsscripts

token-optimizer

Included

Reduce OpenClaw token usage and API costs through smart model routing, heartbeat optimization, budget tracking, and native 2026.2.15 features (session pruning, bootstrap size limits, cache TTL alignment). Use when token costs are high, API rate limits are being hit, or hosting multiple agents at scale. The 4 executable scripts (context_optimizer, model_router, heartbeat_optimizer, token_tracker) are local-only — no network requests, no subprocess calls, no system modifications. Reference files (PROVIDERS.md, config-patches.json) document optional multi-provider strategies that require external API keys and network access if you choose to use them. See SECURITY.md for full breakdown.

Backend & APIsscripts

resend-cli

Included

Use this skill when the task is specifically about operating Resend from an AI agent, terminal session, or CI job via the official resend CLI: installing/authenticating the CLI, sending/listing/updating/cancelling emails, batch sends, domains and DNS, webhooks and local listeners, inbound receiving, contacts, topics, segments, broadcasts, templates, API keys, profiles, or debugging Resend CLI/API failures. Trigger on mentions of Resend CLI, `resend`, `resend doctor`, `resend emails send`, `resend domains`, `resend webhooks listen`, `resend emails receiving`, or agent-friendly terminal automation.

Backend & APIsscripts

alibabacloud-odps-maxframe-coding

Included

Use this skill for MaxFrame SDK development and documentation navigation on Alibaba Cloud MaxCompute (ODPS). Helps answer MaxFrame API, concept, official example, and supported pandas API questions; create data processing programs; read/write MaxCompute tables; debug jobs (remote or local); and build custom DPE runtime images. Trigger when users mention MaxFrame, MaxCompute with MaxFrame, ODPS table processing, DPE runtime, MaxFrame docs/examples, DataFrame/Tensor operations, or GPU runtime setup. Works for both English and Chinese queries about Alibaba Cloud data processing with MaxFrame.

Backend & APIsscripts