AI Prompts for ChatGPT for API Development

I am building an API for [DESCRIBE PRODUCT OR FEATURE]. Design the REST endpoints: list the resources, define the URL structure, choose the right HTTP methods, and explain the response shape for each endpoint.

Compare REST vs GraphQL for my use case: [DESCRIBE DATA REQUIREMENTS AND CLIENT TYPES]. Recommend the better approach, explain the main trade-offs, and outline what the schema or endpoint structure would look like.

Design the error response format for this API. I need consistent error objects that include a machine-readable code, human-readable message, and optional detail fields. Show the format and three example error scenarios.

I need to version this API: [DESCRIBE CURRENT ENDPOINTS]. Recommend a versioning strategy (URL path, header, or query param), explain the trade-offs for my use case, and show how to implement it.

Design the pagination strategy for this endpoint that returns [DESCRIBE COLLECTION]. Compare cursor-based, offset, and keyset pagination, recommend the best one for my case, and show the request and response format.

Write the implementation for this endpoint in [EXPRESS/FASTIFY/HONO/OTHER]: [DESCRIBE ENDPOINT]. Include input validation, error handling, and a clear separation between the HTTP layer and business logic.

I need to add request validation to these endpoints: [LIST ENDPOINTS WITH INPUT SHAPES]. Use [ZOD/JOI/OTHER] to validate inputs and return consistent validation error responses.

Implement authentication for this API using [JWT/API KEYS/OAUTH]. Show the middleware, how to protect routes, how to pass user identity to handlers, and how to handle token expiry.

Write a rate limiter for this API that limits to [N] requests per [WINDOW] per [IP/USER/API KEY]. Show the implementation, how to configure different limits per route, and how to return proper 429 responses.

I need to add caching to this endpoint: [DESCRIBE ENDPOINT AND DATA FRESHNESS REQUIREMENTS]. Recommend a caching strategy (in-memory, Redis, HTTP cache headers), implement it, and explain invalidation.

Write integration tests for this endpoint using [JEST/VITEST/OTHER]: [PASTE ENDPOINT CODE]. Cover the happy path, validation errors, authentication failures, and edge cases like empty results.

I need to test this API against a real database in CI. Set up the test environment with [DESCRIBE DATABASE], write a setup/teardown helper, and show two example tests that use it.

My API sometimes returns inconsistent responses under load. Help me write a stress test using [K6/ARTILLERY/OTHER] that simulates [N] concurrent users hitting [DESCRIBE ENDPOINTS].

Add structured logging to this API: [PASTE HANDLERS]. Log the request, response status, duration, and any errors in a format that works with [DATADOG/CLOUDWATCH/OTHER]. Do not log sensitive fields.

I need to add health check and readiness endpoints to this API. Write the handlers, define what each checks (DB connection, cache, dependencies), and explain how a Kubernetes or load balancer would use them.

Generate OpenAPI 3.1 spec YAML for these endpoints: [PASTE ENDPOINT DEFINITIONS]. Include all request parameters, response schemas, authentication, and example requests and responses.

Write the getting started section of my API documentation. The API is for [DESCRIBE API]. Cover authentication, your first request, handling errors, and rate limits in a clear, practical format.

Create a changelog entry for this API update: [DESCRIBE CHANGES]. Follow semantic versioning, clearly mark breaking changes, and include a migration guide for any endpoints that changed.

Write code examples for this endpoint in JavaScript, Python, and curl: [DESCRIBE ENDPOINT WITH AUTH AND PARAMETERS]. Make the examples copy-paste ready and handle the most common error case.

I need to document the authentication flow for this API: [DESCRIBE AUTH METHOD]. Write a step-by-step guide with diagrams described in text, token lifecycle explanation, and security best practices.