documenting-apis
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.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill 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() |
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-26
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!