Skip to content
Skillpedia
Interfaces (UI/UX)48k · #2153

api-designer

Makes your agent create complete specifications for REST APIs. It generates ready-to-use code based on the system description you provide.

What it does

This tool creates a detailed plan for how different parts of software can communicate with each other over the internet (called REST API endpoints). It defines what each communication 'door' does, what information it sends and receives, and how to handle errors.

When to use it

  • ✓When you need to plan how your application will communicate with other services.
  • ✓When creating the basic structure of a new system or feature.
  • ✓To define the data 'entry points' for a website or application.

Example of what to ask your AI

“Create the REST API endpoints for a simple task management system, with users, tasks, and comments.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/api-designer/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/api-designer/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

The AI analyzes your system description and creates a list of 'doors' (endpoints) your software can use. For each door, it details how to call it (method, path), what to send (request body), what to expect back (success response), and potential errors.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add sickn33/agentic-awesome-skills --skill api-designer

Or download just the file:

curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/api-designer/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

Supporting material availability

This catalog copy contains the inline guidance below, but does not include the following supporting paths. They are external prerequisites, not bundled files:

  • <support-root>/references/domains.md
  • <support-root>/references/testmu_example.md

Obtain the required material from the declared upstream source, or from a user-provided installation of that source. Resolve each path relative to that installation, inspect its contents, and verify any applicable license and execution prerequisites. Do not run a command or claim a referenced procedure was followed until its required file exists. Do not fabricate the missing scripts or treat an unrelated file with the same name as equivalent. Independent steps fully documented here can proceed within the user’s authorized scope; report any dependent step as unavailable.

API Designer Skill

When to Use

Use this skill when you need generates complete, production-ready REST API endpoint specifications for any system or domain the user describes. Use this skill whenever the user asks about API design, API endpoints, REST APIs, API URLs, or says things like "what endpoints do I need for...", "design an API for...",...

You are an expert API architect.

Ask the user if they want just the endpoints or complete detailed response (Enpoints Only/Detail Design). Do not ask these options if the user has specified the details of his requirement in the input already. If the user says Endpoints Only:

  • Output only the endpoints If the user says Detail Design:
  • Output complete design as the structure described in this skill.

Output Format

First list down all the endpoints one after another as output then expand each in this exact structure for each endpoint group (resource):


RESOURCE NAME

METHOD /path/to/endpoint

Short description of what this endpoint does. Not more than two lines.

Headers

Header Value Required
Content-Type application/json Yes
Authorization Bearer <token> Yes/No
X-Api-Key <api-key> Yes/No
(add others as relevant)

Request Body (omit for GET/DELETE if no body)

{
  "field": "type — description",
  "field2": "type — description"
}

Success Response — STATUS_CODE Description

{
  "field": "value or type"
}

Error Codes

Code Meaning
400 Bad Request — invalid or missing fields
401 Unauthorized — missing or invalid token
403 Forbidden — insufficient permissions
404 Not Found
409 Conflict — e.g. duplicate resource
422 Unprocessable Entity — validation failed
500 Internal Server Error

Rules for Output

  1. Cover all major resources for the described system. Infer resources if the user doesn't list them.
  2. Always include CRUD (Create, Read, Update, Delete) where applicable, plus domain-specific actions.
  3. Use RESTful conventions: plural nouns for collections, nested paths for relationships (e.g. /hotels/{id}/rooms).
  4. Auth: Default to Bearer token (JWT) for protected routes. Add API key header where relevant (e.g. third-party integrations). Mark public endpoints clearly.
  5. Request body: Show realistic JSON with field names, types, and brief descriptions. Mark required vs optional fields in comments.
  6. Responses: Show the success response shape with realistic fields. Always include the HTTP status code.
  7. Error codes: List the relevant subset per endpoint — don't always paste all 7. Use judgement.
  8. Pagination: For list endpoints, include query params (page, limit, sort, filter) and wrap responses in a paginated envelope.
  9. Versioning: Prefix all paths with /api/v1/ unless the user specifies otherwise.
  10. Group endpoints by resource (e.g. "Authentication", "Hotels", "Rooms", "Bookings", "Payments", "Reviews").

Pagination Envelope (for list endpoints)

{
  "data": [...],
  "pagination": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5
  }
}

Common Auth Patterns

Choose based on context:

Scenario Auth Method
User-facing apps Authorization: Bearer <JWT>
Server-to-server X-Api-Key: <key>
Public endpoints No auth header needed

…

FAQ

What is a REST API endpoint?

It's like a specific address on the internet that a program uses to request or send information to another program. For example, an address to 'list all tasks' or 'create a new task'.

What does 'production-ready' mean?

It means the plan created by the AI follows best practices and is ready to be used in a real system, securely and efficiently.

Can the AI write the API code?

No, this tool only creates the 'plan' or 'specification' of how the API should work. The actual code needs to be written by a programmer.

Details

Original description by the author

Generates complete, production-ready REST API endpoint specifications for any system or domain the user describes.

repo: sickn33/agentic-awesome-skills

Popularity

GitHub stars
48k
Ranking position
#2153
License
MIT
Updated
10/15/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills