api-design

Design REST and GraphQL APIs with OpenAPI 3.1 specs and security reviews.

3|Updated Feb 24, 2026
One-click install
npx skills add https://github.com/Doumajnik/template --skill api-design-doumajnik
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Doumajnik/template/tree/main/.github/skills/api-design
Command: npx skills add https://github.com/Doumajnik/template --skill api-design-doumajnik

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill eliminates the manual, inconsistent work of designing, documenting, and validating APIs that lead to integration errors, security vulnerabilities, and poor consumer experiences, ensuring APIs follow industry standards and meet all stakeholder requirements.

Core Features & Use Cases

  • Full end-to-end API design workflow: Covers requirements analysis, endpoint design, OpenAPI spec generation, security review, implementation guidance, contract testing, and documentation.
  • Standardized API compliance: Enforces REST/GraphQL conventions, RFC 7807 error formats, and consistent naming, pagination, and filtering patterns.
  • Security and versioning guardrails: Includes built-in security review for auth, input validation, and CORS, plus versioning strategy planning and deprecation timeline management. Use case: For example, when building a new customer-facing e-commerce API, use this skill to define consistent endpoint structures, generate a validated OpenAPI 3.1 spec, run security checks, and produce consumer-ready documentation in a single structured workflow.

Quick Start

Use the api-design skill to create a validated OpenAPI 3.1 specification and security review for the new customer orders API.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I generate a validated OpenAPI 3.1 spec for a new REST API?

To generate a validated OpenAPI 3.1 spec, define consistent endpoint structures and input validation rules, then run security checks and contract testing to ensure standardized API compliance.

What is the best way to plan API versioning and deprecation timelines?

The best way to plan API versioning is to establish versioning strategy guardrails and manage deprecation timelines systematically, ensuring consumer-ready documentation accompanies version migrations.

How do I enforce consistent error formatting like RFC 7807 across REST endpoints?

Enforce RFC 7807 error formatting by applying standardized API compliance rules to your endpoint design, ensuring consistent naming, pagination, and filtering patterns across all REST endpoints.

Can I audit existing endpoints for security and input validation issues?

Yes, you can audit existing endpoints by running a built-in security review that checks authentication, input validation, and CORS configurations to identify and resolve API vulnerabilities.

Does this approach work for both REST and GraphQL API design?

Yes, this approach supports both REST and GraphQL API design by enforcing standard conventions, generating specifications, and validating security guardrails across both architectural styles.

Why do my APIs cause integration failures and consumer friction?

APIs cause integration failures when built with inconsistent, poorly documented structures lacking standardized endpoint design, input validation, and comprehensive consumer-ready documentation.