Home / rudycity / superagent · .agents/skills/api-design-principles/SKILL.md · GitHub

api-design-principles skillA

This file is byte-identical to the first copy the registry indexed. Same content hash, same audit grade.

api-design-principles is agent-read markdown (skill) from rudycity/superagent: Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards..

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# API Design Principles

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

## When to Use This Skill

- Designing new REST or GraphQL APIs
- Refactoring existing APIs for better usability
- Establishing API design standards for your team
- Reviewing API specifications before implementation
- Migrating between API paradigms (REST to GraphQL, etc.)
- Creating developer-friendly API documentation
- Optimizing APIs for specific use cases (mobile, third-party integrations)

## Core Concepts

### 1. RESTful Design Principles

**Resource-Oriented Architecture**

- Resources are nouns (users, orders, products), not verbs
- Use HTTP methods for actions (GET, POST, PUT, PATCH, DELETE)
- URLs represent resource hierarchies
- Consistent naming conventions

**HTTP Methods Semantics:**

- `GET`: Retrieve resources (idempotent, safe)
- `POST`: Create new resources
- `PUT`: Replace entire resource (idempotent)
- `PATCH`: Partial resource updates
- `DELETE`: Remove resources (idempotent)

### 2. GraphQL Design Principles

**Schema-First Development**

- Types define your domain model
…

Read the whole file at its exact version.

How to install

Latest version
mdr add rudycity/superagent/api-design-principles@git:20260626.019dba9
Exact content
mdr add rudycity/superagent/api-design-principles@sha256:1f6166c23c0a0f32

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_jypccuajlz6zqg2x.svg)](https://markdownregistry.com/a/art_jypccuajlz6zqg2x)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
git:20260626.019dba9 latest2026-06-26 019dba9 3,603 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (3603 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

rudycity/superagent · 23 stars · license MIT · pushed 2026-09-22 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_jypccuajlz6zqg2x
GET https://markdownregistry.com/api/v1/resolve?ref=rudycity/superagent/api-design-principles
GET https://markdownregistry.com/api/v1/blob/1f6166c23c0a0f32d703c19d84b3c30c2873daefb9e8732339a009934fa17013

Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

More from rudycity/superagent

AGENTS.md@.agents agents
rudycity/superagent · .agents/AGENTS.md
git:20260904.647a093 · audit A · 23 stars
accessibility-compliance skill
rudycity/superagent · .agents/skills/accessibility-compliance/SKILL.md · Implement WCAG 2.2 compliant interfaces with mobile accessibility, inclusive design patterns, and assistive technology…
git:20260626.019dba9 · audit A · 23 stars
adhd skill
rudycity/superagent · .agents/skills/adhd/SKILL.md · Designed to assist users with ADHD (Attention Deficit Hyperactivity Disorder) by mitigating task paralysis, managing…
git:20260724.a9e7b76 · audit A · 23 stars
agent-browser skill
rudycity/superagent · .agents/skills/agent-browser/SKILL.md · Browser automation CLI for AI agents. Use when the user needs to interact with websites, including navigating pages…
git:20260626.019dba9 · audit A · 23 stars
airflow-dag-patterns skill
rudycity/superagent · .agents/skills/airflow-dag-patterns/SKILL.md · Build production Apache Airflow DAGs with best practices for operators, sensors, testing, and deployment. Use when…
git:20260626.019dba9 · audit A · 23 stars
algorithmic-art skill
rudycity/superagent · .agents/skills/algorithmic-art/SKILL.md · Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users…
git:20260626.019dba9 · audit B · 23 stars
angular-migration skill
rudycity/superagent · .agents/skills/angular-migration/SKILL.md · Migrate from AngularJS to Angular using hybrid mode, incremental component rewriting, and dependency injection updates…
git:20260626.019dba9 · audit A · 23 stars
anti-reversing-techniques skill
rudycity/superagent · .agents/skills/anti-reversing-techniques/SKILL.md · Understand anti-reversing, obfuscation, and protection techniques encountered during software analysis. Use this skill…
git:20260626.019dba9 · audit A · 23 stars
architecture-decision-records skill
rudycity/superagent · .agents/skills/architecture-decision-records/SKILL.md · Write and maintain Architecture Decision Records (ADRs) following best practices for technical decision documentation…
git:20260626.019dba9 · audit A · 23 stars
architecture-patterns skill
rudycity/superagent · .agents/skills/architecture-patterns/SKILL.md · Implement proven backend architecture patterns including Clean Architecture, Hexagonal Architecture, and Domain-Driven…
git:20260626.019dba9 · audit A · 23 stars
article-writing skill
rudycity/superagent · .agents/skills/article-writing/SKILL.md · Write articles, guides, blog posts, tutorials, newsletter issues, and other long-form content in a distinctive voice…
git:20260802.933d9db · audit A · 23 stars
ask-matt skill
rudycity/superagent · .agents/skills/ask-matt/SKILL.md · Ask which skill or flow fits your situation. A router over the user-invoked skills in this repo.
git:20260626.019dba9 · audit A · 23 stars

Every file in rudycity/superagent

Other files named api-design-principles

api-design-principles skill
sickn33/agentic-awesome-skills · plugins/agentic-awesome-skills-claude/skills/api-design-principles/SKILL.md · Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight…
git:20260708.a07936c · audit A · 46,848 stars
api-design-principles skill
wshobson/agents · plugins/backend-development/skills/api-design-principles/SKILL.md · Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight…
git:20260522.be57c0b · audit A · 39,929 stars
api-design-principles skill
dicklesworthstone/pi_agent_rust · tests/ext_conformance/artifacts/agents-wshobson/backend-development/skills/api-design-principles/SKILL.md · Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight…
git:20260205.788be98 · audit A · 1,776 stars
api-design-principles skill
coco-research/coco · skills/api-design-principles/SKILL.md · Use when designing a new REST or GraphQL API, reviewing an API spec before implementation, setting team API standards…
git:20260914.e75f220 · audit A · 478 stars
api-design-principles skill
asymmetric-al/core · .agents/skills/api-design-principles/SKILL.md · Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight…
git:20260311.27f086e · audit A · 383 stars
api-design-principles skill
secondsky/claude-skills · plugins/api-design-principles/skills/api-design-principles/SKILL.md · Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight…
git:20260402.75421fa · audit A · 221 stars
api-design-principles skill
hybridlabor-api/bdb-dev-optimized-agent-skills · skills/global_config/api-design-principles/SKILL.md · Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight…
git:20260827.e4036aa · audit A · 6 stars
api-design-principles skill
hybridlabor-api/aos · skills/global_config/api-design-principles/SKILL.md · Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight…
git:20260827.e9312a3 · audit A · 6 stars

Browse by kind, by grade A, or by owner.