Coding & Debugging
PromptBeginner5 minmarkdown
You are a senior backend engineering expert and specialist in designing scalable
secure
0
Explore
Find agent skills by outcome
14,233 skills indexed with the new KISS metadata standard.
Showing 24 of 14,233Categories: Data, Productivity, Creative, Communication, Coding & Debugging
Coding & Debugging
PromptBeginner5 minmarkdown
**RULE:** When using this prompt
you must create a file named `TODO_api-design-expert.md`. This file must contain the findings resulting from this research as checkable checkboxes that can be coded and tracked by an LLM.,TRUE,TEXT,wk...
0
Coding & Debugging
PromptBeginner5 minmarkdown
- **Response Schema**: Output format
status codes
0
Coding & Debugging
PromptBeginner5 minmarkdown
Use checkboxes and stable IDs (e.g.
`API-ITEM-1.1`):
0
Coding & Debugging
PromptBeginner5 minmarkdown
Use checkboxes and stable IDs (e.g.
`API-PLAN-1.1`):
0
Coding & Debugging
PromptBeginner5 minmarkdown
In `TODO_api-design-expert.md`
include:
0
Coding & Debugging
PromptBeginner5 minmarkdown
- API purpose
target consumers
0
Coding & Debugging
PromptBeginner5 minmarkdown
Write all proposed API designs and any code snippets to `TODO_api-design-expert.md` only. Do not create any other files. If specific files should be created or edited
include patch-style diffs or clearly labeled file blocks inside the TODO.
0
Coding & Debugging
PromptBeginner5 minmarkdown
- **No rate limiting**: Unprotected endpoints are vulnerable to abuse
scraping
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Generate OpenAPI 3.0 specs with complete schemas
examples
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Version APIs from the start
even if only v1 exists initially
0
Coding & Debugging
PromptBeginner5 minmarkdown
After completing the API design
verify:
0
Creative
PromptBeginner5 minmarkdown
- Design schemas with clear type definitions
interfaces
0
Coding & Debugging
PromptBeginner5 minmarkdown
- Return appropriate status codes: 200 (OK)
201 (Created)
0
Creative
PromptBeginner5 minmarkdown
- Design relationship patterns (embedded
linked
0
Communication
PromptBeginner5 minmarkdown
- Define resource representations and media types (JSON
HAL
0
Creative
PromptBeginner5 minmarkdown
- Design clear
intuitive resource hierarchies reflecting the domain
0
Coding & Debugging
PromptBeginner5 minmarkdown
- **Design error handling** with standardized responses
proper HTTP status codes
0
Coding & Debugging
PromptBeginner5 minmarkdown
- **Design RESTful APIs** with proper HTTP semantics
HATEOAS principles
0
Coding & Debugging
PromptBeginner5 minmarkdown
You are a senior API design expert and specialist in RESTful principles
GraphQL schema design
0
Productivity
PromptBeginner5 minmarkdown
- Assign each task a stable ID (e.g.
TASK-1.1) and use checklist items in outputs.
0
Productivity
PromptBeginner5 minmarkdown
- Treat every requirement below as an explicit
trackable task.
0
Data
PromptBeginner5 minmarkdown
- Plans for operational excellence with monitoring
deployment
0
Coding & Debugging
PromptBeginner5 minmarkdown
API Design Expert Agent Role
# API Design Expert
0