trae-skill-backend-api-doc-generator
v1.0.1
Published
Trae skill for generating backend API documentation
Maintainers
Readme
trae-skill-backend-api-doc-generator
Trae skill for generating backend API documentation. This skill analyzes backend project code structure, automatically identifies API interfaces and data models, generates standardized documentation for backend system design including API endpoints, data models, and state machines.
Installation
Global Installation
npm install -g trae-skill-backend-api-doc-generatorProject Installation
npm install --save-dev trae-skill-backend-api-doc-generatorUsage
Activate the Skill
After installation, run the following command to install the skill into Trae's skill directory:
npx trae-skill-backend-api-doc-generator install:skillUsing in Trae IDE
- Open Trae IDE
- Right-click on your backend project
- Select "Run Skill" → "backend-api-doc-generator"
- The skill will analyze your project and generate
backend-doc.mdin the project root
Features
- Code Structure Analysis: Scans project directory to understand overall structure
- Tech Stack Identification: Detects programming language, framework, database, and other technologies
- API Interface Extraction: Identifies API endpoints, routes, request/response parameters
- Data Model Analysis: Extracts data models, relationships, and database schema information
- State Machine Identification: Detects and documents state transitions
- Documentation Generation: Creates structured document focusing on API design, data models, and state machines
Supported Technologies
- Languages: Node.js, Python, Java, Go, PHP
- Frameworks: Express, Nest.js, Django, Flask, Spring Boot, Gin, Laravel
- Databases: MySQL, PostgreSQL, MongoDB, SQLite
- Other: Redis, RabbitMQ, Docker, Kubernetes
Output
The generated backend-doc.md includes:
- Project structure analysis
- Tech stack identification
- API endpoints documentation with request/response parameters
- Data model diagrams with relationships
- State machine diagrams
- System architecture overview
- Configuration information
License
MIT
