Agent skill

API Design

RESTful API design best practices and conventions guide. An agent skill from Leavesfly/Jimi.

No licenceAuto-check passedBackend & APIs

Install API Design

skills CLI

$ npx skills add Leavesfly/Jimi --skill api-design -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install Leavesfly/Jimi api-design --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/Leavesfly/Jimi.git skills-src && mkdir -p .claude/skills && cp -r skills-src/src/main/resources/skills/api-design .claude/skills/api-design && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "api-design" agent skill from https://github.com/Leavesfly/Jimi/tree/main/src/main/resources/skills/api-design into .claude/skills/api-design/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-design", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/Leavesfly/Jimi/tree/main/src/main/resources/skills/api-design

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add Leavesfly/Jimi --skill api-design -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install Leavesfly/Jimi api-design --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/Leavesfly/Jimi.git skills-src && mkdir -p .agents/skills && cp -r skills-src/src/main/resources/skills/api-design .agents/skills/api-design && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "api-design" agent skill from https://github.com/Leavesfly/Jimi/tree/main/src/main/resources/skills/api-design into .agents/skills/api-design/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-design", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add Leavesfly/Jimi --skill api-design -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install Leavesfly/Jimi api-design --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/Leavesfly/Jimi.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/src/main/resources/skills/api-design .cursor/skills/api-design && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "api-design" agent skill from https://github.com/Leavesfly/Jimi/tree/main/src/main/resources/skills/api-design into .cursor/skills/api-design/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-design", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/Leavesfly/Jimi.git --path src/main/resources/skills/api-design

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add Leavesfly/Jimi --skill api-design -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install Leavesfly/Jimi api-design --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/Leavesfly/Jimi.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/src/main/resources/skills/api-design .gemini/skills/api-design && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "api-design" agent skill from https://github.com/Leavesfly/Jimi/tree/main/src/main/resources/skills/api-design into .gemini/skills/api-design/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-design", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install Leavesfly/Jimi api-design

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add Leavesfly/Jimi --skill api-design -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/Leavesfly/Jimi.git skills-src && mkdir -p .github/skills && cp -r skills-src/src/main/resources/skills/api-design .github/skills/api-design && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "api-design" agent skill from https://github.com/Leavesfly/Jimi/tree/main/src/main/resources/skills/api-design into .github/skills/api-design/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-design", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add Leavesfly/Jimi --skill api-design -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install Leavesfly/Jimi api-design --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/Leavesfly/Jimi.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/src/main/resources/skills/api-design .opencode/skills/api-design && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "api-design" agent skill from https://github.com/Leavesfly/Jimi/tree/main/src/main/resources/skills/api-design into .opencode/skills/api-design/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-design", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: api-design
GitHub stars: 237
Token cost: ~349 tokens
SKILL.md length: 117 words
Files: 1
Skills in repo: 9
Repo updated: Aug 19, 2026
First seen: Oct 7, 2026
Licence: None found

At a glance

RESTful API design best practices and conventions guide. An agent skill from Leavesfly/Jimi.

Works in 6 steps: Resource-Oriented Design → HTTP Methods → URL Structure → …
Tasks that involve API design
SKILL.md covers Core Principles and Best Practices
Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

API Design is an agent skill from Leavesfly/Jimi. RESTful API design best practices and conventions guide

Its SKILL.md is about 350 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs, covering API design and REST APIs. The repository describes itself as: Jimi：打造Java程序员专属的开源ClaudeCode.

When your agent uses it

Tasks that involve API design
Tasks that involve REST APIs

Example prompts

“/api-design”

Workflow steps

6 steps, taken from the step headings in SKILL.md.

Resource-Oriented Design
HTTP Methods
URL Structure
Response Format
Error Handling
Status Codes

What it can do on your machine

Read from SKILL.md and the folder at commit 75e1158. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are json).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

API Design loads about 349 tokens when it runs. Until then it costs about 17 tokens; SKILL.md has 117 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~17
When it runs · the whole SKILL.md, loaded when a task matches: ~349

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Without a licence we can't republish the file, so here is its outline and opening line. It has 117 words (~349 tokens).

“This skill provides comprehensive guidance for designing RESTful APIs following industry best practices.”

— opening of SKILL.md by Leavesfly

name: api-design

Read the full SKILL.md on GitHub

Files

Just SKILL.md in src/main/resources/skills/api-design of Leavesfly/Jimi.

Open the folder on GitHubat commit 75e1158

Compare with similar skills

API Design next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

API Design compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
API Design this skillLeavesfly/Jimi	237	—	~349	Automated safety check: Pass	None	1 mo ago
API DesignerJeffallan/claude-skills	12k	2 repos	~2k	Automated safety check: Pass	MIT	4 days ago
Nodejs Backend Patternsever-works/ever-works	158	18 repos	~4k	Automated safety check: Pass	AGPL-3.0	2 days ago
Pangolin CRUD Endpointsfosrl/pangolin	23k	—	~461	Automated safety check: Pass	Custom licence	today
Old Coder API DesignAmazingAng/old-coder	749	1 repos	~3.4k	Automated safety check: Pass	MIT	1 mo ago
REST API Contract Reviewdecebals/claude-code-java	751	1 repos	~2.8k	Automated safety check: Pass	MIT	1 mo ago

Similar skills

API Designer
Jeffallan/claude-skills
Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.
12k GitHub starsUsed in 2 repos~2k tokens
Backend & APIsAuto-check passed
Nodejs Backend Patterns
ever-works/ever-works
Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices.
158 GitHub starsUsed in 18 repos~4k tokens
Backend & APIsAuto-check passed
Pangolin CRUD Endpoints
fosrl/pangolin
Use whenever asked to add, create, or scaffold a CRUD endpoint, router, or entity in this repo's server (create/list/get/update/delete handlers, new…
23k GitHub stars~461 tokensUpdated today
Backend & APIsAuto-check passed
Old Coder API Design
AmazingAng/old-coder
Reviews or designs an HTTP/JSON API's endpoints, auth, pagination, versioning and deprecations, guarding against inventing a bespoke interface or silently breaking consumers.
749 GitHub starsUsed in 1 repo~3.4k tokens
Backend & APIsAuto-check passed
REST API Contract Review
decebals/claude-code-java
Reviews REST API design for correct HTTP verbs, versioning, DTO use, consistent responses and backward compatibility before an API change ships.
751 GitHub starsUsed in 1 repo~2.8k tokens
Backend & APIsAuto-check passed
Backend Fundamentals
DanielPodolsky/ownyourcode
Reviews API design, REST conventions, and backend architecture.
290 GitHub starsUsed in 1 repo~1.1k tokens
Backend & APIsAuto-check passed

Questions about API Design

What does API Design do?

RESTful API design best practices and conventions guide. An agent skill from Leavesfly/Jimi. API Design is an agent skill from Leavesfly/Jimi.

When should I use API Design?

API Design fits situations like: tasks that involve API design; tasks that involve REST APIs.

How do I install API Design in Claude Code?

Run `npx skills add Leavesfly/Jimi --skill api-design -a claude-code`. Or copy the skill folder (src/main/resources/skills/api-design in Leavesfly/Jimi) into .claude/skills/api-design in your project. Claude Code loads it when a task matches its description.

How do I install API Design in Codex?

Run `npx skills add Leavesfly/Jimi --skill api-design -a codex`. Or copy the skill folder (src/main/resources/skills/api-design in Leavesfly/Jimi) into .agents/skills/api-design in your project. Codex loads it when a task matches its description.

Can I use API Design in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add Leavesfly/Jimi --skill api-design -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-design, .gemini/skills/api-design, .github/skills/api-design and .opencode/skills/api-design in your project.

What does API Design need to run?

SKILL.md names no scripts, command-line tools or credentials: API Design is instructions for the agent only.

Does API Design access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is API Design safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does API Design use?

No licence was found for API Design or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.

How many tokens does API Design use?

About 349 tokens (SKILL.md is roughly 1.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to API Design?

Skills that share tags, products or a category with API Design: API Designer (Jeffallan/claude-skills, 12k stars), Nodejs Backend Patterns (ever-works/ever-works, 158 stars), Pangolin CRUD Endpoints (fosrl/pangolin, 23k stars) and Old Coder API Design (AmazingAng/old-coder, 749 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Design?

Leavesfly (a GitHub user) maintains it in Leavesfly/Jimi, which has 237 GitHub stars. The repository holds 9 skills in this directory. The repository was last updated on August 19, 2026.

Source: Leavesfly/Jimi on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

API Design

Install API Design

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Files

Compare with similar skills

Similar skills

API Designer

Nodejs Backend Patterns

Pangolin CRUD Endpoints

Old Coder API Design

REST API Contract Review

Backend Fundamentals

More from Leavesfly/Jimi

Weather

Database Design

Git Commit Guide

Unit Testing

Java Best Practices

Code Review

Questions about API Design

Install API Design

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Files

Compare with similar skills

Similar skills

More from Leavesfly/Jimi

Related

Questions about API Design