API Documentation Pro
Generate robust Swagger/OpenAPI specifications directly from your source code or endpoint descriptions.
Use Case
Essential for backend developers and architects who need to maintain up-to-date, interactive API documentation for their teams and public users.
The Prompt
I want you to act as a Technical Writer. Generate a clean OpenAPI 3.0 specification in YAML format for the following API endpoint.
Endpoint Logic/Description:
[Insert description or paste controller code here]
Requirements:
1. Define all request parameters (Path, Query, Header).
2. Define the Request Body schema (if applicable).
3. Include multiple Response codes (200 OK, 400 Bad Request, 401 Unauthorized, 500 Error).
4. Add clear descriptions and examples for every field.
5. Use standard naming conventions.Tips for Success
- Copy-Paste: You can literally paste your SvelteKit
+server.tsor Express route file, and the AI will extract the logic. - Validation: Ask the AI to check the generated YAML against common OpenAPI best practices.