api-design-first

Solid

Use when designing HTTP APIs with OpenAPI, versioning, authentication, rate limits, idempotency, error contracts, and observability requirements.

Web & Frontend 25 stars 6 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 85/100

Stars 20%
47
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# API Design First Acknowledgement: Shared by Peter Bamuhigire, techguypeter.com, +256 784 464178. Design APIs as contracts before code. This skill produces the OpenAPI 3.1 contract and its companion auth / error / idempotency / observability artifacts that downstream frontend, mobile, SDK, security, and reliability skills depend on. <!-- dual-compat-start --> ## Use When - Designing a new HTTP API (REST or GraphQL decision open), or adding endpoints to an existing API. - Normalising an existing API against the house contract (envelope, error model, versioning, rate limits). - Producing the OpenAPI contract that SDK, frontend, mobile, contract-testing, and security skills will consume. - Choosing an auth method and writing the auth/role matrix for a new service. - Defining idempotency keys and observability notes handed to `reliability-engineering` and `observability-monitoring`. ## Do Not Use When - The task is purely client-side consumption of a third-party API (load the relevant SDK or integration skill). - The task is full threat modelling — load `vibe-security-skill`; this skill only records the auth model. - GraphQL-specific hardening is needed — load `graphql-patterns`. ## Required Inputs - Context map and critical-flow table from `system-architecture-design`. - Access-pattern list from `database-design-engineering`. - Consumers, trust boundaries, and latency budget for each endpoint. - Tenancy model (single-tenant, shared schema, schema-per-tenant) so `tenant_i...

Details

Author
peterbamuhigire
Repository
peterbamuhigire/chwezi-dev-engine
Created
7 months ago
Last Updated
3 days ago
Language
HTML
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category