Define API contracts with endpoints, Pydantic models, and auth considerations.
npx skills add https://github.com/g-zenr/relay-api --skill design-api-g-zenr
Please help me install this Agent Skill. Skill: design-api Source: https://github.com/g-zenr/relay-api/tree/main/.claude/skills/design-api Command: npx skills add https://github.com/g-zenr/relay-api --skill design-api-g-zenr
This Skill helps ensure API designs are robust, well-documented, and implementable by providing a structured workflow for defining API contracts before development begins.
Use the design-api skill to design the API contract for a new user authentication service.
High-intent search queries and answers about installing and using this skill.
Contract first API design defines your endpoints, request/response schemas, and security rules before writing implementation code. You need it to ensure robust, well-documented APIs and prevent structural mismatches during development.
To design a REST API specification with Pydantic models, define your service requirements, outline endpoints, and establish request/response bodies. This structured workflow generates a complete specification document for subsequent implementation.
The best way to organize routes and endpoints is using a structured design process that maps out requirements, groups endpoints logically, and defines consistent Pydantic schemas for request and response bodies across the service.
Yes, you can define auth and security considerations before implementing REST API endpoints. The design workflow includes specifying authentication requirements and route organization directly within the initial API contract document.
Yes, contract first API design works for building a user management service by guiding you to define all necessary endpoints, such as create user and get user, alongside their request/response schemas and error handling upfront.
ibnuhalimmGather project context and produce a detailed architecture plan.
hamzaPixlGenerate Pydantic schemas, FastAPI CRUD routes, repositories, and tests.
AZANIRGenerate pytest-compatible Python API tests from OpenAPI contracts using httpx.
Harmeet10000Generate and validate OpenAPI 3.1 specifications from code or design-first specs.
