Skill Details
Runtime
(gpt-5.5)
Example user message
[userMessage]: Add Swagger documentation to my Express API.
Example agent response
Project Detected:
Node.js Express API with JWT authentication and JSON request validation
---
Documentation Added:
- OpenAPI 3.1 specification
- Documentation for existing public and authenticated routes
- Swagger UI mounted at /docs
---
Endpoints Documented:
- POST /auth/login
- GET /users/me
- GET /products
- POST /products
- PATCH /products/{id}
---
Schemas Added or Updated:
- LoginRequest
- AuthResponse
- UserResponse
- ProductRequest
- ProductResponse
- ErrorResponse
---
Files Modified:
- src/docs/openapi.js
- src/docs/schemas.js
- src/app.js
- tests/openapi.test.js
- package.json
---
Commands Executed:
- npm install swagger-ui-express
- npm test
- npm run lint
---
Validation Result:
Tests and linting passed. The generated OpenAPI document loaded successfully and all documented routes matched active Express routes.
---
Documentation Access:
Start the application and open http://localhost:3000/docs.
---
Remaining Gaps:
- Two internal maintenance routes were excluded because their authorization requirements were not confirmed
---
Important Notes:
All examples use fictional values. JWT secrets and real authorization tokens are not included in the documentation.
Or get it with Select10 Select prompts/mo — under $2 each
Learn moreBy purchasing this skill, you agree to our terms of service
GPT-5.5
Automatically create accurate API documentation from an existing backend project.
This skill detects routes, request schemas, responses, authentication, and error behavior, then generates OpenAPI or Swagger documentation and validates it.
✔ Document existing endpoints
✔ Generate OpenAPI schemas
✔ Add Swagger UI
✔ Include auth and errors
✔ Validate documentation
Perfect for APIs, SaaS backends, integrations, and developer platforms.
...more
Added 1 week ago
