Skip to content
TrustedSkillsbeta
Back to all skills

Api Design Principles

Checked
hermeticormus·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 ormus-solutions/libreuiux-claude-code --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

hermeticormus

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 hermeticormus/libreuiux-claude-code at 2a69cbbc46.

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

Commit
2a69cbbc46
Manifest
plugins/backend-development/skills/api-design-principles/SKILL.md
Scanned
5 files, 1,668 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 helps design APIs following established principles. It provides guidance on creating well-structured, maintainable, and user-friendly interfaces for software systems. The skill focuses on aspects like resource naming conventions, request methods, status codes, and error handling to ensure API consistency and predictability.

When to use it

  • Designing a new RESTful API endpoint for an application.
  • Reviewing existing API documentation for clarity and adherence to best practices.
  • Generating API specifications (e.g., OpenAPI/Swagger) from high-level descriptions.
  • Troubleshooting issues related to API usability or unexpected behavior.
  • Refactoring an older API to improve its design and maintainability.

Key capabilities

  • Resource naming conventions
  • HTTP request methods selection
  • Status code usage guidelines
  • Error handling best practices
  • API specification generation (OpenAPI/Swagger)

Example prompts

  • "Design a REST endpoint for managing user profiles, following API design principles."
  • "Suggest appropriate HTTP status codes for a successful data retrieval and an error scenario in my API."
  • "Generate an OpenAPI specification based on this description of my API: [description]."

Tips & gotchas

This skill assumes some basic understanding of RESTful architecture. For optimal results, provide clear and concise descriptions of the desired API functionality.