Api Design Rest
CheckedHelps with API, design, REST APIs as part of developing backend services and APIs workflows.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add kentoshimizu/sw-agent-skills --skill api-design-rest -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
kentoshimizu
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned kentoshimizu/sw-agent-skills at 5b7bafb626.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 5b7bafb626
- Manifest
- skills/api-design-rest/SKILL.md
- Scanned
- 19 files, 1,648 lines
About this skill
What it does
This skill enables AI agents to design REST APIs, including defining endpoints, request methods (GET, POST, PUT, DELETE), and response formats. It can generate API specifications based on provided requirements or existing data models. The agent will produce a structured description of the API, suitable for implementation by developers.
When to use it
- Rapid prototyping: Quickly outline an API structure before development begins.
- Documentation generation: Create clear and concise documentation from an existing API design.
- Data model translation: Convert data models into a RESTful API specification.
- API modernization: Refactor or redesign legacy APIs to adhere to REST principles.
Key capabilities
- Endpoint definition
- Request method selection (GET, POST, PUT, DELETE)
- Response format design (JSON, XML)
- API Specification generation
Example prompts
- "Design a REST API for managing customer orders."
- "Generate an API specification based on this data model: [data model description]."
- "Create a GET endpoint to retrieve product details by ID."
Tips & gotchas
The agent's output is a design; it does not generate code. You will need developers to implement the designed API.