prompt

OpenAPI Spec Generator

Produces an OpenAPI specification outline for an endpoint including parameters, responses, and examples.

VettedUpdated June 2026

The prompt

Generate an OpenAPI 3 spec outline for a {{method}} {{path}} endpoint that {{purpose}}. Include request parameters and body schema, success and error responses with status codes, and one example for each. Auth: {{auth}}.

Did it work? Rate this prompt

Variables

methodHTTP method

pathEndpoint path

purposePurpose

authAuth method

Example output

GET /users/{id} — retrieves a single user. Parameters: path id (integer, required). Responses: 200 returns a User object {id, email, name, created_at}; example {id: 12, email: a@b.com, name: Sam, created_at: 2025-01-04}. 404 returns {error: user not found}. 401 returns {error: unauthorized}. Auth: Bearer token in the Authorization header. The full spec would nest these under paths, components.schemas.User, and securitySchemes.bearerAuth.

Details

Author

AI Khazna

License

—

Security

Vetted

Type

prompt

Frequently asked questions

What is the OpenAPI Spec Generator prompt?

Produces an OpenAPI specification outline for an endpoint including parameters, responses, and examples.

Is OpenAPI Spec Generator free?

Yes, it is free to use.

Related assets

More curated picks in Development & Code.

prompt

Refactors code for readability and structure while preserving behavior, with rationale.

Code Refactor Assistant

Refactors code for readability and structure while preserving behavior, with rationale.0+

prompt

Turns a bug report into a structured debugging plan with hypotheses and checks to isolate the cause.

Debugging Strategy Helper

Turns a bug report into a structured debugging plan with hypotheses and checks to isolate the cause.0+

prompt

Reviews a code diff or snippet for bugs, security, readability, and edge cases.

Code Reviewer

Reviews a code diff or snippet for bugs, security, readability, and edge cases.0+

prompt

Generates unit tests for a function, including edge cases and failure paths.

Unit Test Generator

Generates unit tests for a function, including edge cases and failure paths.0+

prompt

Writes a clear PR description with summary, changes, testing, and review notes from a diff or change list.

Pull Request Description Writer

Writes a clear PR description with summary, changes, testing, and review notes from a diff or change list.0+

prompt

Writes docstrings, inline comments, and README sections for existing code.

Code Documentation Writer

Writes docstrings, inline comments, and README sections for existing code.0+

Audit before you install

Run any source through our checks - AI visibility, security, performance, and stack detection.

AI Agent / MCP Server Tester

ai testing

Automated Web Security Scan

security

AI Content Quality Test

arabic content

Site Stack Detector

migration

PageSpeed Analyzer

performance

AI SEO / AEO / GEO Audit

ai visibility

llms.txt Generator

ai visibility

Schema / JSON-LD Builder

ai visibility

Readability Score

arabic content

AI Cost Calculator

ai testing

Headline Analyzer

arabic content