temp_preferences_customTHE FUTURE OF PROMPT ENGINEERING

API Design Architect

Designs REST and gRPC APIs covering resource modeling, versioning, authentication, rate limiting, pagination, and documentation.

terminalgeminitrending_upRisingcontent_copyUsed 812 timesby Community

oauthversioningOpenAPIgrpcrestapidesign

gemini

0 words

System Message

## Role & Identity You are a Principal API Engineer who has designed APIs used by millions of developers. You design APIs that are intuitive, consistent, evolvable, and performant — with exceptional developer experience. ## Task Design a production-grade API for the described product or service. ## Process 1. **Resource Modeling** — Noun-based resources, resource hierarchy, relationship representation. 2. **HTTP Method Semantics** — GET/POST/PUT/PATCH/DELETE correctness, idempotency. 3. **URL Design** — Naming conventions, pluralization, nesting depth limits, query parameters. 4. **Request/Response Schema** — Consistent field naming (camelCase/snake_case), required/optional. 5. **Error Format** — RFC 7807 Problem Details, error codes, human/machine readable. 6. **Authentication** — OAuth 2.0/API Key/JWT strategy, token passing convention. 7. **Versioning** — URL path vs. header versioning, backward compatibility rules. 8. **Pagination** — Cursor vs. offset, page size limits, `next` link in response. 9. **Rate Limiting** — Rate limit headers (RateLimit-*), 429 response with retry-after. 10. **Documentation** — OpenAPI 3.0 spec, example requests/responses, changelog. ## Output Format ``` ## API Resource Catalog ## Endpoint Definitions ## OpenAPI 3.0 Spec Excerpt ## Authentication Flow ## Developer Guide ```

User Message

Design API for: {&{PRODUCT_OR_SERVICE}}

About this prompt

## API Design Architect Designs production REST APIs with intuitive resource modeling, consistent error formats, OAuth authentication, versioning strategy, and complete OpenAPI documentation. ### Use Cases - Design a REST API for a project management platform with OAuth and webhook support - Architect a public API with versioning, rate limiting, and developer portal documentation - Design a GraphQL API for a content platform with subscription support and pagination

When to use this prompt

check_circleDesign REST API for project management platform with OAuth 2.0 and webhook event subscription.
check_circleArchitect public API with URL versioning, rate limiting headers, and complete developer portal.
check_circleDesign GraphQL API for content platform with cursor pagination and real-time subscriptions.

signal_cellular_altintermediate

Latest Insights

Stay ahead with the latest in prompt engineering.

View blogchevron_right

How to Write System Prompts That Actually Work

Article

person Admin•schedule 5 min read

How to Write System Prompts That Actually Work

System prompts set the rules of the game for every AI interaction. This hands-on guide shows you exactly how to structure them for reliability and consistency.

Claude vs GPT-4o: Which Model Fits Your Use Case?

Article

person Admin•schedule 5 min read

Claude vs GPT-4o: Which Model Fits Your Use Case?

Choosing between Claude and GPT-4o is less about which is "better" and more about which fits your specific task. Here is a practical breakdown.

How Our Design Team Cut Brief-Writing Time by 70% with AI

Article

person Admin•schedule 5 min read

How Our Design Team Cut Brief-Writing Time by 70% with AI

A real-world case study on how a 12-person design team at a product agency standardised their creative brief process using prompt templates on PromptShip.

Why AI Hallucinations Happen (and How to Reduce Them)

Article

person Admin•schedule 5 min read

Why AI Hallucinations Happen (and How to Reduce Them)

Hallucinations are not bugs — they are a fundamental property of how language models work. Understanding why they happen is the first step to minimising them.

The State of AI Coding Assistants in 2026

Article

person Admin•schedule 5 min read

The State of AI Coding Assistants in 2026

From autocomplete to autonomous agents — AI coding tools have changed dramatically. Here is where things stand and what to expect next.

From Idea to Shipped Prompt: A Solo Founder's AI Workflow

Article

person Admin•schedule 5 min read

From Idea to Shipped Prompt: A Solo Founder's AI Workflow

One founder. No team. A dozen AI-powered tools and a tight prompt library. Here is the workflow that runs a bootstrapped SaaS doing $15k MRR.

Recommended Prompts

chatgptshieldTrusted

bookmark

MCP API Integration Specialist

Builds MCP servers wrapping REST/GraphQL APIs with tool generation, authentication handling, pagination, and rate limit management.

Rate Limiting System Designer

Designs rate limiting systems covering sliding window, token bucket, leaky bucket, distributed counters, and per-tier limits.

API Contract PR Reviewer

Expert review of API contract changes in PRs covering backward compatibility, consumer impact, versioning strategy, and contract testing.

Breaking Changes PR Reviewer

Expert review of PRs introducing breaking changes covering API compatibility, schema changes, client impact analysis, and migration path quality.

Book Cover Design Prompter

Generate book cover design prompts calibrated to genre, market, and visual hierarchy.

Advanced Ux Ui Design Techniques

Expert-crafted prompt for advanced ux ui design techniques — delivers specific, actionable guidance for ux ui design practitioners who need results, not theory.

star 0fork_right 96

bolt

pin_invoke