api-design-agent

Design API contracts and documentation for RESTful and GraphQL services.

Updated Dec 3, 2025
One-click install
npx skills add https://github.com/Unicorn/Radium --skill api-design-agent
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-agent
Source: https://github.com/Unicorn/Radium/tree/main/skills/design/api-design-agent
Command: npx skills add https://github.com/Unicorn/Radium --skill api-design-agent

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designs clear, consistent, and well-documented RESTful and GraphQL APIs so teams can build, integrate, and maintain services without ambiguity or repeated rework.

Core Features & Use Cases

  • Endpoint & Resource Modeling: Identify resources, relationships, URLs, and CRUD operations for web services.
  • Schema & Documentation Generation: Produce OpenAPI specs, GraphQL schemas, request/response examples, and error responses.
  • Security & Versioning: Specify authentication flows, authorization rules, token management, rate limiting, and API versioning strategies.
  • Use Case: Rapidly produce a production-ready API contract for a task management app including OpenAPI docs and authentication recommendations.

Quick Start

Design a RESTful API for a task management application with Users and Tasks, including OpenAPI specification, request/response schemas, authentication strategy, and example error responses.

Frequently Asked Questions about api-design-agent

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

FAQPage Schema
How do I generate an OpenAPI specification for a RESTful service?

To generate an OpenAPI specification, model your resources, URLs, and CRUD operations. This process outputs endpoint definitions, request/response schemas, and error handling policies for your RESTful services.

What's the best way to design authentication flows and versioning strategies for APIs?

Designing authentication and versioning requires specifying token management, authorization rules, and API versioning strategies. This approach generates security recommendations compatible with common frameworks and scalability constraints.

Can I create both RESTful and GraphQL schemas for web and mobile applications?

Yes, you can create both RESTful and GraphQL schemas. The design process produces endpoint specifications for RESTful services and GraphQL artifacts tailored for web and mobile applications.

How do I structure error handling policies and rate limiting for backend services?

Structuring error handling policies and rate limiting involves defining consistent error responses and specifying rate limits. This generates clear API contracts to help teams integrate services without ambiguity.

Does API design work with common backend frameworks and scalability constraints?

API design applies to backend engineers and API architects working with common frameworks. It generates authentication recommendations and endpoint specifications compatible with your scalability constraints.

What is the process for endpoint and resource modeling in API design?

Endpoint and resource modeling identifies your resources, relationships, URLs, and CRUD operations. This produces a clear, developer-friendly API contract for your web services.