skills.rest
GeneralJerel
GeneralJerelCOMMUNITY
Explore all skills by this author →
GitHub

create-api-design

Design REST or GraphQL APIs from feature specifications with schemas and contracts.

6|Updated Feb 19, 2026
Search Tags:#documentation#rest#graphql#endpoints#schemas#api-design
One-click install
npx skills add https://github.com/GeneralJerel/chalk-skills --skill create-api-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-api-design
Source: https://github.com/GeneralJerel/chalk-skills/tree/main/skills/create-api-design
Command: npx skills add https://github.com/GeneralJerel/chalk-skills --skill create-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design a reliable method to translate feature specifications into production-ready API designs, aligning endpoints, schemas, and contracts to accelerate implementation and reduce miscommunication.

Core Features & Use Cases

  • Infer resource boundaries and required operations (CRUD plus domain actions) from feature descriptions.
  • Enforce RESTful and GraphQL conventions, including endpoint naming, auth patterns, pagination, and error contracts, matching the project's existing patterns.
  • Produce a comprehensive API design document with endpoints, schemas, error contracts, and versioning guidance for consistent downstream work.

Quick Start

Provide the resource name and the required operations to generate the API design.

Frequently Asked Questions about create-api-design

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

FAQPage Schema
How do I design a REST API from a feature specification?▼

Yes, you can design a GraphQL API by inferring resource boundaries and domain actions from your feature description, then aligning schemas, error contracts, and auth requirements with your project's existing conventions for consistent implementation.

What's the best way to define API error contracts and pagination rules?▼

Yes, this API design process supports existing auth requirements by aligning endpoint definitions, schemas, and conventions with your project's established authentication patterns and authorization rules.

How do I generate API documentation from resource definitions?▼

Yes, this API design process handles domain actions by supporting both CRUD operations and custom domain actions inferred from your feature descriptions, aligning them with RESTful or GraphQL conventions.

Can I use this to design APIs for existing projects with established conventions?▼

Yes, this API design process explicitly aligns new endpoint definitions, request/response schemas, and URL design rules with your existing API patterns, conventions, and auth requirements to ensure consistency.

What do I need to provide to start the API design process?▼

To start the API design process, you need to provide the resource name and the required operations, which generates an API design aligned with your feature specification and project conventions.

Related Skills

Explore More Software Engineering Skills→
Nhqvu2005Nhqvu2005
54

api-designer

Generate RESTful API endpoints and export them to OpenAPI specifications.

Community
Intermediate
imehrimehr

api-validation

Enforce API contracts with Zod and OpenAPI schemas for REST and RPC endpoints.

Community
Intermediate
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced
Axel-DaMageAxel-DaMage
2

api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Community
Advanced