Api Design
CheckedHelps with 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 travisjneuman/.claude --skill 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
travisjneuman
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 travisjneuman/.claude at 050878886e.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 050878886e
- Manifest
- skills/api-design/SKILL.md
- Scanned
- 1 file, 443 lines
About this skill
What it does
This skill helps design APIs, focusing on clarity and usability. It can generate API specifications (likely OpenAPI/Swagger), suggest improvements to existing designs based on best practices, and translate natural language descriptions into structured API definitions. The goal is to streamline the API development process and ensure consistent, well-documented interfaces.
When to use it
- You need to create an initial API design from scratch for a new project.
- You have an existing API that needs refactoring or improvement in terms of clarity and consistency.
- You want to automatically generate API documentation based on your code or designs.
- You're struggling to translate user requirements into a concrete API specification.
Key capabilities
- API Specification Generation (likely OpenAPI/Swagger)
- API Design Review & Improvement Suggestions
- Natural Language to API Definition Translation
Example prompts
- "Design an API endpoint for retrieving customer order history."
- "Review this existing API definition and suggest improvements for clarity: [paste API definition]"
- "Translate the following user story into a REST API design: 'As a user, I want to be able to search for products by keyword.'"
Tips & gotchas
The skill's output will depend heavily on the quality of your input. Providing clear and detailed requirements or existing designs is crucial for optimal results.