design-api

Define API contracts with endpoints, Pydantic models, and auth considerations.

Updated Feb 13, 2026

Search Tags:#pydantic #api design #specification #rest api #endpoint design #contract first

Ready to run

npx skills add https://github.com/g-zenr/relay-api --skill design-api-g-zenr

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps ensure API designs are robust, well-documented, and implementable by providing a structured workflow for defining API contracts before development begins.

Core Features & Use Cases

Structured Design Process: Guides users through requirements gathering, endpoint definition, Pydantic model creation, and route organization.
Consistency: Promotes uniform API design across projects.
Use Case: Before building a new user management service, use this Skill to define all necessary endpoints (e.g., create user, get user, update user), their request/response schemas, and error handling.

Quick Start

Use the design-api skill to design the API contract for a new user authentication service.

Frequently Asked Questions about design-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What is contract first API design and when do I need it?▼

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.

How do I design a REST API specification with Pydantic models?▼

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.

What is the best way to organize routes and endpoints for a new API?▼

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.

Can I define auth and security considerations before implementing REST API endpoints?▼

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.

Does contract first API design work for building a user management service?▼

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.