DB & API DesignBeginnerFREE

REST API Endpoint Design

Design API endpoints following RESTful principles.

Prompt

Design REST API for this feature:
1. Resource URL patterns (plural nouns)
2. HTTP method mapping (GET/POST/PUT/PATCH/DELETE)
3. Request/response JSON schemas
4. Status code definitions
5. Error response format (RFC 7807)
6. Pagination, filtering, sorting parameters

Also write in OpenAPI 3.0 format.

Use Case

Use this when designing a backend API for a new feature but unsure how to structure URLs, request/response formats, and status codes to be truly RESTful. Paste feature requirements to get endpoint designs following RESTful principles plus an OpenAPI 3.0 spec document.

Related Prompts

DB & API DesignBeginnerFREE

Database Schema Design

Design a database schema matching requirements.

DB & API DesignIntermediate

Supabase RLS Policy Design

Design Supabase Row Level Security policies.

Unlock with Pro subscription

DB & API DesignIntermediate

Data Migration Plan

Plan safe data migration for schema changes.

Unlock with Pro subscription