Designs REST API contracts, resource models, pagination schemes, and OpenAPI 3.1 specifications.
npx skills add https://github.com/Lynricsy/HyperSkills --skill api-design-lynricsy
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/Lynricsy/HyperSkills/tree/main/skills/api-design Command: npx skills add https://github.com/Lynricsy/HyperSkills --skill api-design-lynricsy
redocly lint exiting clean and a prism mock server exercising the happy path, pagination, validation failures, and auth failures. - Use Case: Given a legacy endpoint list with /getWarehouse and /createOrder style paths, produce a redesigned contract with noun-based resources, correct status codes, an idempotency strategy for retried writes, and a validated OpenAPI 3.1 document. ## Quick Start Ask the agent to redesign your service's endpoint list as a proper REST contract with resources, methods, status codes, pagination, and an OpenAPI document validated by redocly lint and prism mock.High-intent search queries and answers about installing and using this skill.
Paginate every collection from its first release, defaulting to an opaque cursor over keyset pagination with a unique tiebreaker like (created_at, id) in both the sort and the cursor. Keep offset only for screens needing numbered pages, document a default and maximum page size, and make total counts opt-in.
Read the document end to end, list the implied resources, then check each operation against rules for verbs in paths, method semantics, 2xx failures, missing Location headers, and undeclared error responses. Finish by running redocly lint and exercising a prism mock, since lint misses issues like unpaginated collections and bare array responses.
RFC 9457 obsoletes RFC 7807 with the format unchanged in substance, but adds the problem type registry and about:blank guidance. New contracts should cite 9457, use application/problem+json, and let clients identify problems by the stable type URI rather than human-readable title or detail strings.
Judge changes on three axes: wire, source, and semantic compatibility. Adding a required request field, renaming or retyping a field, adding pagination to an existing collection, and changing defaults or units are all breaking; adding optional fields, new endpoints, and new request enum values are compatible.
Make an operation asynchronous when its p99 duration exceeds about a second or the client should poll before proceeding. Return 202 with an Operation-Location header pointing at a status-monitor resource plus Retry-After, and never model PATCH as a long-running operation.
No, it covers only the wire contract: resources, URIs, methods, status codes, pagination, errors, and the OpenAPI document. Implementation concerns like routers, handlers, validation wiring, and ORM access belong to framework-specific skills such as fastapi, nodejs-backend, java-spring, or csharp-dotnet.
machenjieDesign SDK and library contracts to minimize breaking upgrades across semver.
berea-chExtract OpenAPI specifications from API codebases in JSON or YAML.
sugar-cat7Automate API contract testing against OpenAPI specifications using Hono's testClient.
jokken79Build a typed GraphQL API with resolvers, DataLoader, and federation.