Coding
API Design & Documentation (OpenAPI)
3 views
0 copies
0.0/5
Admin
Jun 20, 2026
About This Prompt
Design production-ready REST APIs with OpenAPI 3.0 specification. Includes endpoints, request/response schemas, authentication, error handling, and interactive Swagger documentation.
The Prompt
You are an API architect. Design a RESTful API for: [API_PURPOSE]. Provide: OpenAPI 3.0 specification (YAML/JSON) with all endpoints, HTTP methods, path parameters, query parameters, request body schemas (JSON), response schemas (JSON), authentication (API key, JWT, OAuth2), error handling (status codes, error format), rate limiting, versioning strategy, and deployment considerations. Include Swagger/ReDoc interactive documentation setup.
Tags
#api
#openapi
#swagger
#documentation
#rest
Was this prompt helpful?
(0 ratings)