Skip to content
cccskills
FreePublished on GitHub

api-generating

Generate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.

The English summary is being prepared. Showing the original description.

See how to install

Files included (3)

  • SKILL.md1.7 KB
  • scripts/detect-routes.py4.4 KB
  • templates/api-doc.md1018 B

SKILL.md (original)

Review the instructions the agent will receive before you install.

API 文档生成 Skill

工作流程 — MANDATORY

IMPORTANT: You MUST follow these steps in order. DO NOT skip or substitute any step.

Step 1: Route Discovery(路由发现)

You MUST use the Python script for route detection:

python3 skills/scripts/detect-routes.py src/

DO NOT manually search for routes using Grep — the script handles edge cases (dynamic routes, middleware-mounted sub-routers, re-exported routes) that Grep patterns will miss.

Step 2: Route Analysis(路由分析)

For each route discovered by the script:

  1. Read the route handler source file
  2. Identify: HTTP method, path, parameters, request body schema, response schema
  3. Check for authentication middleware (e.g., requireAuth, isAdmin)
  4. Check for validation middleware (e.g., validate(schema))

Step 3: Documentation Generation(文档生成)

Use the template at templates/api-doc.md to generate documentation.

Output rules:

  • One markdown file per route group (e.g., docs/api/users.md)
  • Include request/response examples
  • Mark authenticated endpoints with 🔒

Reference Files

  • Route detection script: scripts/detect-routes.py
  • Documentation template: templates/api-doc.md
  • Express routing patterns: see PATTERNS.md (same directory)

Quality Checklist

Before finishing, verify:

  • All routes from script output are documented
  • Request/response schemas match actual code
  • Auth requirements are marked
  • Examples are valid JSON

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

API design patterns and conventions for this project. Covers RESTful URL naming, response format standards, error handling, and authentication requirements. Use when writing or reviewing API endpoints, designing new APIs, or making decisions about request/response formats.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

Generate API endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

Review code for quality, security, and best practices. Use when the user asks for code review, wants feedback on their code, mentions reviewing changes, or asks about code quality.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

Generate an interactive tree visualization of your codebase. Use when exploring a new repo or understanding project structure.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

See all skills by huangjia2019

Report a problem with this skill