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 ashchupliak/dream-team --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
ashchupliak
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 ashchupliak/dream-team at 96827b33a0.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 96827b33a0
- Manifest
- skills/api-design/SKILL.md
- Scanned
- 1 file, 107 lines
About this skill
What it does
This skill assists in designing APIs, focusing on clarity and usability. It can generate API specifications based on natural language descriptions, ensuring consistent endpoints and data structures. The goal is to streamline the development process by providing a structured approach to API design.
When to use it
- You need to define an API for a new software project or feature.
- You want to ensure consistency across existing APIs.
- You're struggling to translate requirements into a clear and actionable API specification.
- You’re looking for help generating OpenAPI specifications from high-level descriptions.
Key capabilities
- Generates API specifications
- Focuses on clarity and usability in API design
- Creates consistent endpoints and data structures
- Works with natural language descriptions
Example prompts
- "Design an API endpoint to retrieve customer order history."
- "Generate OpenAPI specification for a simple product catalog API."
- "Create an API that allows users to upload images and receive thumbnail URLs."
Tips & gotchas
The skill's effectiveness relies on clear and detailed natural language descriptions of the desired API functionality. Providing specific examples or use cases will improve the quality of generated specifications.