Api Designer
CheckedProvides API guidance and assistance for developing backend services and APIs.
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 peopleforrester/claude-dotfiles --skill api-designer -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
peopleforrester
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 peopleforrester/claude-dotfiles at db7caa0374.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- db7caa0374
- Scanned
- 1 file, 244 lines
About this skill
What it does
The peopleforrester-api-designer skill allows AI agents to design APIs based on natural language descriptions. It can generate OpenAPI specifications (Swagger) and provide guidance on API structure, endpoints, and data models. This facilitates rapid prototyping and documentation of new APIs.
When to use it
- Rapid Prototyping: Quickly create an initial API specification for a new project without manual coding.
- API Documentation Generation: Automatically generate OpenAPI specifications from existing API designs or descriptions.
- Brainstorming & Exploration: Explore different API design options based on user requirements and feedback.
- Code Generation Assistance: Use the generated OpenAPI spec as input to code generation tools for various programming languages.
Key capabilities
- Generates OpenAPI (Swagger) specifications.
- Designs APIs from natural language descriptions.
- Provides guidance on API structure, endpoints, and data models.
Example prompts
- "Design an API for managing a library of books with endpoints for adding, deleting, and searching."
- "Create an OpenAPI specification for an e-commerce API including product listings, shopping cart, and checkout functionality."
- "I need an API to track user activity on my website. Suggest the necessary endpoints and data formats."
Tips & gotchas
The quality of the generated API design heavily depends on the clarity and detail provided in the initial prompt. Be as specific as possible about desired functionalities and data structures for optimal results.