api

Design, scaffold, and document RESTful and GraphQL APIs with OpenAPI schemas.

1|Updated Jan 16, 2026
One-click install
npx skills add https://github.com/coreindustries/core-ai-template --skill api-coreindustries
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api
Source: https://github.com/coreindustries/core-ai-template/tree/main/.claude/skills/api
Command: npx skills add https://github.com/coreindustries/core-ai-template --skill api-coreindustries

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of designing, scaffolding, and documenting API endpoints, ensuring adherence to best practices and generating necessary specifications.

Core Features & Use Cases

  • API Design: Define REST or GraphQL endpoints, including request/response schemas and validation rules.
  • Code Scaffolding: Generate boilerplate code for API routes, services, and basic tests based on project conventions.
  • Documentation Generation: Automatically create OpenAPI or GraphQL schema documentation from existing endpoints.
  • Validation: Check API designs and implementations against established best practices for naming, status codes, and schema consistency.
  • Use Case: Quickly design a new set of user management API endpoints, generate the initial code structure, and produce an OpenAPI specification for frontend integration.

Quick Start

Use the api skill to design REST API endpoints for the 'products' resource.

Frequently Asked Questions about api

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

FAQPage Schema
How do I scaffold REST API routes and services from a design specification?

To scaffold REST API routes, define your endpoints and request/response schemas to generate boilerplate code for services and basic tests. This produces an initial code structure adhering to project conventions.

Can I generate OpenAPI documentation from existing GraphQL schemas?

Generating OpenAPI documentation applies to REST endpoints, while GraphQL uses its own schema documentation. You can automatically create the necessary specifications from existing endpoint definitions for frontend integration.

What is the best way to validate API naming conventions and status codes?

Validating API naming conventions and status codes involves checking designs against established best practices. This ensures schema consistency and maintainable API specifications across your implementation.

Do I need to define request and response schemas before scaffolding API endpoints?

Yes, defining request and response schemas including validation rules is required. This structured API design step ensures the generated boilerplate code and OpenAPI specifications accurately reflect your endpoints.

What are the limitations of using scaffolding for API code generation?

Scaffolding for API code generation provides initial boilerplate routes and tests rather than complete business logic. It streamlines the design phase but requires manual implementation for complex service behaviors.

When do I need to use OpenAPI specifications for RESTful API development?

You need OpenAPI specifications for RESTful API development when frontend integration or structured documentation is required. Generating these specifications ensures your endpoint designs adhere to industry best practices.