Skip to content
TrustedSkillsbeta
Back to all skills

Api Design Principles

Listed
sickn33·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 sickn33/agentic-awesome-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

sickn33

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 failed 1 of 6 checks. A failure is not proof of bad intent; it means something in the code needs a human to look at it before you run it.

  • Declares what it does: failed

    No SKILL.md was found in the skill's directory.

    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 sickn33/agentic-awesome-skills at c808e6e480.

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

Commit
c808e6e480
Manifest
skills/api-design-principles/SKILL.md
Scanned
0 files
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

This skill helps you design, refactor, and review REST and GraphQL APIs to ensure they are intuitive, scalable, and maintainable. It guides you through key considerations like defining consumers, choosing API styles, specifying errors, and establishing versioning strategies. The skill leverages a detailed implementation playbook with patterns, checklists, and templates to aid in the process.

When to use it

  • Designing new REST or GraphQL APIs from scratch.
  • Refactoring existing APIs to improve usability and maintainability.
  • Establishing API design standards for your development team.
  • Reviewing API specifications before implementation begins.
  • Migrating between different API paradigms, such as from REST to GraphQL.

Key capabilities

  • Guidance on defining consumers, use cases, and constraints for APIs.
  • Assistance in choosing appropriate API styles (REST or GraphQL).
  • Support for specifying error handling, versioning, pagination, and authentication strategies.
  • Access to detailed patterns, checklists, and templates via the resources/implementation-playbook.md file.

Example prompts

  • "I'm designing a new REST API for managing user profiles. What are some key design principles I should consider?"
  • "We want to migrate our existing REST API to GraphQL. Can you guide me through the process and highlight potential challenges?"
  • "Our team needs to establish API design standards. What are some essential elements we should include?"

Tips & gotchas

  • This skill is most effective when designing or modifying APIs, not for implementation guidance within a specific framework.
  • Always validate the output with environment-specific testing and expert review – do not treat it as a complete solution.
  • If you're unsure about inputs, permissions, safety boundaries, or success criteria, stop and ask for clarification.