Back to Skills

documenting-apis

verified

Generate API specification from codebase - endpoints, types, schemas. Use when generating API documentation, documenting endpoints, or when user mentions API docs, API仕様, OpenAPI, Swagger, REST API, endpoint documentation.

View on GitHub

Marketplace

thkt-development-workflows

thkt/claude-config

Plugin

development-skills

Development Skills

Repository

thkt/claude-config
3stars

skills/documenting-apis/SKILL.md

Last Verified

January 22, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/thkt/claude-config/blob/main/skills/documenting-apis/SKILL.md -a claude-code --skill documenting-apis

Installation paths:

Claude
.claude/skills/documenting-apis/
Powered by add-skill CLI

Instructions

# API Specification Generation

## Detection

| Category       | Pattern                                |
| -------------- | -------------------------------------- |
| Endpoints      | Express, Fastify, Next.js, Flask, etc. |
| Functions      | tree-sitter, TypeScript, JSDoc         |
| Types          | interface, type, Zod, Pydantic         |
| OpenAPI        | openapi.yaml, swagger.yaml             |
| Authentication | Auth middleware, JWT, OAuth patterns   |

## Framework Patterns

| Framework | Pattern                      |
| --------- | ---------------------------- |
| Express   | `app.get()`, `router.post()` |
| Next.js   | `app/api/**/route.ts`        |
| Flask     | `@app.route()`               |
| FastAPI   | `@app.get()`, `@app.post()`  |

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
609 chars