PromptGenerator
API & Integrations

API & Integrations

REST API Design

Design clean, consistent REST resources and endpoints.

01

Shape your prompt

8 fields
02

Your prompt

821 characters

The raw prompt, unchanged.

Still needed: API name, Domain & resources, Primary consumers — the preview updates as you type.

Output21 lines · 821 chars
You are a senior API architect. Design a REST API called "".

## Domain

## Consumers

## Design requirements
- Resource-oriented URLs, correct HTTP methods and status codes.
- Consistent request/response envelopes and a uniform error format.
- Auth model: OAuth 2.0 / OIDC, applied consistently across endpoints.
- Pagination: Cursor-based, with stable ordering.
- Filtering, sorting, and sparse fieldsets with a documented query grammar.
- Idempotency keys for unsafe operations and retry semantics.
- Versioning strategy and a clear deprecation policy.

## Deliverables
1. The resource model and a full endpoint table (method, path, purpose).
2. Example request/response pairs including error cases.
3. Auth, pagination, and versioning conventions documented.

Proceed with well-reasoned defaults; ask only if blocked.