Api Design
This is the skill you reach for when you need to turn a fuzzy service boundary or integration idea into an actual contract that implementation, testing, and docs can all work from. It walks you through choosing REST versus GraphQL with real reasons, modeling resources and operations, defining request/response shapes including the error cases people forget, and producing an OpenAPI spec or GraphQL SDL before anyone writes server code. The checklist explicitly separates contract design from writing tutorials or implementing auth middleware, and it hands off cleanly to other skills when the work shifts to documentation portals or backend testing. It assumes you have enough clarity to define a real interface, not that you're still figuring out what the feature should do.
- skills.sh installs
- 174
- GitHub stars
- 22
- last updated
- Jun 3, 2026
Install
$ npx -y skills add akillness/oh-my-skills --skill api-design --agent claude-codeInstalls into .claude/skills of the current project.
Files
API Design
Use this skill to turn a vague integration idea, backend feature, or service boundary into a stable API contract that other skills can build on.
The job is not to generate pretty docs. The job is to:
- choose the right API style for the problem
- define resources, operations, inputs, outputs, and failure semantics
- make compatibility and versioning decisions explicit
- produce a contract artifact that implementation, testing, and documentation can share
- surface tradeoffs before the team hardens the wrong interface
Read references/contract-review-checklist.md and references/boundary-guide.md before handling unusual or high-risk API work.
If the user mainly needs:
- reference docs, tutorials, example-heavy guides, or doc portal setup → use
api-documentation - auth implementation or token/session configuration → use
authentication-setup - contract/integration test strategy → use
backend-testing - schema/index/storage design → use
database-schema-design
Sponsors
Agent CaffeineSponsoredClose your lid, come back to finished work
SnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthly
WaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthly
knobsSponsoredSee your site on any phone, any day, in any languageDetails
- Repository
- github.com/akillness/oh-my-skills
- Categories
- Backend & APIs, Design & UI/UX
- First seen
- Jun 3, 2026
More from akillness/oh-my-skills
All 81- Api Documentation174
- Plannotator173
- Playwriter173
- Testing Strategies173
- Database Schema Design172
- React Best Practices172
- Agentation171
- Bmad Idea171
- Code Review171
- Marketing Automation171
- Obsidian Plugin171
- Opencontext171
- Standup Meeting171
- Task Estimation171
- Ui Component Patterns171
- Changelog Maintenance170
- Monitoring Observability170
- Sprint Retrospective170
- Deployment Automation169
- Ohmg169
- Security Best Practices169
- Authentication Setup168
- Fabric168
- Firebase Ai Logic168
Recommended
More Backend & APIs
postgresql-best-practiceswimolivier/postgresql-best-practicespostgresql best practices172skills.sh installs