Skip to content
TrustedSkillsbeta
Back to all skills

Api Design

Checked
affaan-m·vlatest·backend·MIT

Helps with API, design as part of developing backend services and APIs workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add affaan-m/ecc --skill api-design -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

affaan-m

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.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

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 affaan-m/everything-claude-code at d3b8a3e908.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
d3b8a3e908
Manifest
skills/api-design/SKILL.md
Scanned
4 files, 1,439 lines
Copies in repo
3 — all of them scanned
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

The affaan-m-api-design skill enables AI agents to design and structure RESTful APIs with best practices, including route planning, request/response formatting, and versioning strategies. It also supports generating API documentation in formats like Swagger or OpenAPI.

When to use it

  • You need to create a new API for a web application or microservice architecture.
  • You want to ensure your API follows RESTful conventions and is scalable.
  • Your team requires well-documented APIs for integration with third-party services.
  • You're refactoring an existing API to improve its structure and usability.

Key capabilities

  • Generate RESTful endpoint structures based on user requirements.
  • Create OpenAPI/Swagger documentation automatically.
  • Suggest versioning strategies (e.g., URL path, header-based).
  • Provide guidance on request/response formats (JSON, XML).
  • Offer security recommendations like authentication and rate limiting.

Example prompts

  • "Design a RESTful API for a task management application with endpoints for creating, updating, and deleting tasks."
  • "Generate OpenAPI documentation for an e-commerce API that includes user authentication and product listings."
  • "Suggest a versioning strategy for a public-facing API that needs to support backward compatibility."

Tips & gotchas

  • Ensure your requirements are clearly defined before using the skill to avoid ambiguity in endpoint design.
  • While the skill provides documentation templates, manually review them for accuracy and completeness.