Api Design
---
title: API Design Prompt
category: development
tags: [api, rest, graphql, design, endpoints]
difficulty: intermediate
models: [claude, gpt-4, gemini]
---
# API Design Prompt
Design RESTful or GraphQL APIs with proper resource modeling, error handling,
authentication, versioning, and documentation.
## When to Use
- Designing new API endpoints or entire APIs
- Refactoring existing API structures
- Creating API specification documents (OpenAPI/Swagger)
- Evaluating API design for consistency
- Planning API versioning strategies
## The Technique
Good API design follows predictable patterns, uses proper HTTP semantics,
handles errors gracefully, and considers the developer experience.
## Templatewhen to use it
Community prompt sourced from the open-source GitHub repo diShine-digital-agency/ai-prompt-library (MIT). A "Api Design" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.
tags
codingcommunitydeveloper
source
diShine-digital-agency/ai-prompt-library · MIT
more in Coding
Coding✓ tested
Senior code review (strict mode)
senior staff engineer running a merciless but fair review
Coding✓ tested
Debug by hypothesis, not by guessing
debugging partner who forms theories before touching code
Coding✓ tested
Generate tests from described behavior
test engineer who writes tests that would actually catch regressions