API Endpoint Designer
Generates complete RESTful API endpoint specifications including HTTP methods, request/response formats, authentication, error codes, and OpenAPI snippets.
When to use this prompt
Use this when you need to design new API endpoints for a feature or resource and want comprehensive specifications that follow REST conventions. It's particularly helpful when you need to maintain consistency with existing API patterns in your application.
You are a backend architect who designs clean, RESTful APIs. Design API endpoints for [FEATURE/RESOURCE]. Context: - Application type: [TYPE] - Authentication method: [AUTH] - Existing patterns: [PATTERNS - if any] For each endpoint, provide: 1. HTTP method and path 2. Request parameters/body (with types) 3. Response format (success and error) 4. Authentication requirements 5. Rate limiting considerations 6. Example request/response Also include: - OpenAPI/Swagger specification snippet - Error code standards - Pagination approach (if applicable) - Versioning strategy - Security considerations Follow REST best practices and be consistent with existing patterns.
Free to use — the optimizer tailors this template to your exact task and target AI.
How to customize it
- [FEATURE/RESOURCE] — Specify the feature or resource you're building endpoints for, such as 'user profiles', 'payment processing', or 'inventory management'
- [TYPE] — Describe your application type (e.g., mobile app backend, microservice, public API, internal tool)
- [AUTH] — State your authentication method like JWT, OAuth2, API keys, or session-based auth
- [PATTERNS] — Document any existing API conventions in your codebase, such as naming schemes, response envelope structures, or error formats; leave empty if starting fresh
What you'll get back
The AI returns a structured specification for each endpoint covering HTTP method, path, request/response schemas with data types, authentication needs, and rate limiting. You'll also receive OpenAPI/Swagger snippets, error code standards, pagination strategy if relevant, versioning approach, and security considerations tailored to your context.
More Coding prompts
Technical Spec Writer
Generates a structured technical specification document covering problem statement, design, implementation plan, and risks for engineering features or projects.
Code Reviewer
Instructs AI to perform a comprehensive code review covering bugs, security, performance, style, and best practices with severity ratings and corrections.
Security Audit Checklist
Generates a structured security audit checklist for code review, covering authentication, input validation, data protection, API security, and infrastructure concerns.
Legacy Code Modernization
Generates a structured modernization plan for legacy code, including assessment, migration options, phased implementation, testing strategy, and risk management.
Make this prompt yours
PromptWizz rewrites this template around your specific task, audience, and target AI — and shows you why each change works.
Try the Optimizer Free