skills.rest
yankeeinlondon
yankeeinlondonCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

schematic-define

Define and validate REST and WebSocket API contracts for client generation.

3|Updated Jan 10, 2026
Search Tags:#api#openapi#schematic#definition#websocket#define
One-click install
npx skills add https://github.com/yankeeinlondon/rusty-biscuit --skill schematic-define
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: schematic-define
Source: https://github.com/yankeeinlondon/rusty-biscuit/tree/main/.claude/skills/schematic-define
Command: npx skills add https://github.com/yankeeinlondon/rusty-biscuit --skill schematic-define

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a centralized, authoritative model for REST and WebSocket API definitions used by Schematic to generate clients and enforce runtime contracts. It provides a single source of truth for RestApi, Endpoint, RestMethod, AuthStrategy, EnvMapping, and OpenAPI extension handling, ensuring changes propagate to generators and clients.

Core Features & Use Cases

  • Central definitions for RestApi, Endpoint, RestMethod, AuthStrategy, ApiKeyLocation, EnvMapping, and OpenAPI extension models.
  • Ensures consistency between design docs, tests, and generated code across schematic-define.
  • Use Case: Defining API contracts for a new service and updating existing definitions to reflect evolving auth requirements.

Quick Start

Define or edit schematic-define models to update REST/WS API contracts for generated clients.

Frequently Asked Questions about schematic-define

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

FAQPage Schema
How do I define API contracts for deterministic client generation?▼

Defining API contracts for deterministic client generation involves specifying RestApi, Endpoint, and RestMethod models to enforce runtime behavior and ensure generated clients align with the specification. It serves as a centralized source of truth for REST and WebSocket APIs.

When do I need OpenAPI extension models for REST and WebSocket APIs?▼

OpenAPI extension models are needed for REST and WebSocket APIs when you must enforce generation contracts and environment mappings to align generated clients and runtime code with the specification. They ensure deterministic behavior across design docs, tests, and generated code.

How do I configure AuthStrategy and ApiKeyLocation for API definitions?▼

Configuring AuthStrategy and ApiKeyLocation for API definitions requires updating centralized schematic models to reflect evolving auth requirements. These definitions ensure that authentication changes propagate consistently to generators and runtime client code.

Does schematic-define support WebSocket API definitions or only REST APIs?▼

Schematic-define supports both WebSocket and REST API definitions for deterministic client generation. It provides a centralized, authoritative model covering Endpoint, RestMethod, and related OpenAPI extensions to enforce runtime contracts across both protocols.

What is the best way to maintain a single source of truth for API definitions across tests and generated code?▼

Maintaining a single source of truth for API definitions across tests and generated code requires centralized models for RestApi and EnvMapping. This approach ensures consistency between design docs, tests, and generated clients by propagating changes to generators automatically.

Why does my generated client not align with my API specification runtime behavior?▼

Generated clients may not align with API specification runtime behavior if OpenAPI extension handling and environment mappings are not properly enforced. Centralized definitions for RestApi and Endpoint models ensure generated code matches the specification deterministically.

Related Skills

Explore More Software Engineering Skills→
gil00pitagil00pita

openapi

Generate OpenAPI 3.1 specifications and TypeScript types from API definitions.

Community
Advanced
RomualdPRomualdP

API Contracts Generator

Generate synchronized DTOs and TypeScript types for Next.js and NestJS API contracts.

Community
Advanced
yankeeinlondonyankeeinlondon
3

schematic

Design API definitions and generate API clients with the Schematic toolchain.

Community
Intermediate
ricardohg1998-createricardohg1998-create

api-contract-enforcer

Defines and enforces API contracts for OpenAPI and GraphQL projects.

Community
Intermediate