Rest Api Design
CheckedHelps with REST APIs, API, design 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 emvnuel/skills --skill rest-api-design -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
emvnuel
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 emvnuel/skill.md at 33fc5e12d6.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 33fc5e12d6
- Manifest
- rest-api-design/SKILL.md
- Scanned
- 7 files, 1,159 lines
About this skill
What it does
This skill assists in designing REST APIs, focusing on proper HTTP methods (GET, POST, PUT, DELETE), resource naming conventions, and request/response structures. It helps ensure the API is well-structured for maintainability and ease of use by clients. The skill can generate API specifications based on provided requirements or critique existing designs.
When to use it
- You're starting a new project and need help designing the API from scratch.
- You have an existing API design that needs review and optimization.
- You want to ensure your API adheres to RESTful principles.
- You're documenting an API for developers and require clear specifications.
Key capabilities
- Generates API specifications.
- Critiques existing API designs.
- Ensures adherence to RESTful principles.
- Provides guidance on resource naming conventions.
Example prompts
- "Design a REST API endpoint for managing user profiles, including create, read, update, and delete operations."
- "Review this API design [paste design] and suggest improvements based on RESTful best practices."
- “Generate an OpenAPI specification for an API that allows users to retrieve product information.”
Tips & gotchas
The skill's output is most effective when provided with clear requirements or a well-defined problem domain. The more context you provide, the better the generated design will be.