How do I install the API Design skill?

Run npx skillmds@latest add hongmaple0820/api-design in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the API Design skill do?

RESTful API conventions It is listed under Integrations & APIs on SkillMD.

Is API Design safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with API Design?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is API Design free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published API Design?

hongmaple0820 (@hongmaple0820) published this skill. Their other Agent Skills are listed on their SkillMD profile.

API Design

Name: API Design
Author: hongmaple0820

RESTful API conventions

hongmaple0820 e1f151f 831 B Updated Sep 17, 2026

Integrations & APIs

Install

Press C to copy

$ npx skillmds@latest add hongmaple0820/api-design

Installs into ~/.claude/skills (or .claude/skills inside a project). Restart Claude Code to pick it up.

Download SKILL.md

＋ Add to collection

README badge

[![SkillMD](https://skillmd.com/badge/hongmaple0820/api-design.svg)](https://skillmd.com/skills/hongmaple0820/api-design)

Trust & safety

Audits pending

Not yet audited · commit e1f151f

Works with: Claude Code Claude.ai OpenAI Codex +

File contents

API Design Standards

Consistent, intuitive interfaces.

Endpoint Naming

Resource-based: /users, /orders
Plural nouns
Nest for relationships: /users/:id/orders

HTTP Methods

Method	Purpose
GET	Retrieve
POST	Create
PUT	Replace
PATCH	Update
DELETE	Remove

Response Format

{
  "success": boolean,
  "data": object | null,
  "error": string | null,
  "meta": { total, page, limit }
}

Status Codes

Code	Meaning
200	Success
201	Created
400	Bad request
401	Unauthorized
403	Forbidden
404	Not found
500	Server error

Security

Auth on all endpoints
Rate limiting
Input validation
No secrets in responses

hongmaple0820/scale-engine/tree/main/.scale/skills/api-design commit e1f151f3cd

Frequently asked questions

npx skillmds@latest add hongmaple0820/api-design