Generate API Documentation from Existing Endpoints
Helps you generate API documentation from existing endpoints quickly, while still surfacing the open questions a real version of this work would need answered.
When to use this
Use when you need to generate API documentation from existing endpoints and want a structured starting point instead of a blank page.
Prompt template
Act as a senior software engineer. Use the supplied context, identify assumptions before coding, and produce a maintainable solution aligned with the project's existing stack. Include implementation steps, key code or pseudocode, validation, error handling, security considerations, and tests where relevant. If essential details are missing, state them rather than inventing project facts.
Task: Generate API documentation from existing endpoints.
Context to use:
- Project or subject: {{project_or_subject}}
- Constraints and preferences: {{constraints}}
- Existing material or reference notes: {{source_material}}
Response format:
1. Brief recommendation or approach
2. Main deliverable, organized into clear sections
3. Assumptions and unresolved questions
4. Validation or quality checklistCustomize
Project or subject is required
Preview
Act as a senior software engineer. Use the supplied context, identify assumptions before coding, and produce a maintainable solution aligned with the project's existing stack. Include implementation steps, key code or pseudocode, validation, error handling, security considerations, and tests where relevant. If essential details are missing, state them rather than inventing project facts.
Task: Generate API documentation from existing endpoints.
Context to use:
- Project or subject: {{project_or_subject}} missing
- Constraints and preferences:
- Existing material or reference notes:
Response format:
1. Brief recommendation or approach
2. Main deliverable, organized into clear sections
3. Assumptions and unresolved questions
4. Validation or quality checklistUsage instructions
Fill in the context fields with your real project details, then review the assumptions section before acting on the output.
Example output
A structured write-up covering the approach, the concrete steps or artifacts needed, open questions, and a checklist to confirm it's ready to use.
Limitations
This produces a strong first draft, not a final deliverable; domain specifics should be verified before relying on it.
Rate this prompt
Not yet rated