Skip to content
TrustedSkillsbeta
Back to all skills

Api Design Principles

Checked
secondsky·vlatest·backend·MIT

Helps with API, design, principles 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 secondsky/claude-skills --skill api-design-principles -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

secondsky

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 secondsky/claude-skills at 8837836131.

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

Commit
8837836131
Manifest
plugins/api-design-principles/skills/api-design-principles/SKILL.md
Scanned
1 file, 251 lines
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

This skill provides a curated set of guidelines for designing robust and maintainable APIs, focusing on best practices for structure, documentation, and interoperability. It helps developers create interfaces that are intuitive for both human consumers and automated AI agents to consume reliably.

When to use it

  • Architecting new services: Define contract structures and versioning strategies before writing code.
  • Refactoring legacy endpoints: Evaluate existing APIs against modern standards for consistency and clarity.
  • AI Agent Integration: Ensure API responses are formatted in ways that AI agents can easily parse and act upon.
  • Team Standardization: Establish a shared language for backend teams to reduce technical debt.

Key capabilities

  • Principles for RESTful resource modeling and HTTP method usage.
  • Guidelines for error handling, status codes, and response formatting.
  • Strategies for API versioning to support long-term maintenance.
  • Best practices for documentation generation and discoverability.
  • Considerations for security, rate limiting, and authentication flows.

Example prompts

  • "Review my current user management endpoint against standard API design principles."
  • "Generate a schema for a new payment service following best practices for idempotency and error reporting."
  • "List the top three common mistakes in API versioning and how to avoid them."

Tips & gotchas

  • These principles are general guidelines; specific cloud provider constraints may require deviations.
  • Always pair design documentation with automated testing to ensure adherence to defined contracts.