Home / hashgraph-online / awesome-codex-plugins · GitHub

api-design SKILL.md skillA

api-design from hashgraph-online/awesome-codex-plugins is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add hashgraph-online/awesome-codex-plugins/api-design@git:20260512.6523792

Pins git:20260512.6523792 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: hashgraph-online/awesome-codex-plugins
Path: plugins/Colin4k1024/tsp/skills/api-design/SKILL.md
Versions recorded: 1
Latest version: git:20260512.6523792, committed May 12, 2026
Size: 13,110 bytes
Repository stars: 1,501
License: Apache-2.0

REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# API Design Patterns

Conventions and best practices for designing consistent, developer-friendly REST APIs.

## When to Activate

- Designing new API endpoints
- Reviewing existing API contracts
- Adding pagination, filtering, or sorting
- Implementing error handling for APIs
- Planning API versioning strategy
- Building public or partner-facing APIs

## Resource Design

### URL Structure

```
# Resources are nouns, plural, lowercase, kebab-case
GET    /api/v1/users
GET    /api/v1/users/:id
POST   /api/v1/users
PUT    /api/v1/users/:id
PATCH  /api/v1/users/:id
DELETE /api/v1/users/:id

# Sub-resources for relationships
GET    /api/v1/users/:id/orders
POST   /api/v1/users/:id/orders

# Actions that don't map to CRUD (use verbs sparingly)
POST   /api/v1/orders/:id/cancel
POST   /api/v1/auth/login
POST   /api/v1/auth/refresh
```

### Naming Rules

```
# GOOD
/api/v1/team-members          # kebab-case for multi-word resources
/api/v1/orders?status=active  # query params for filtering
/api/v1/users/123/orders      # nested resources for ownership

# BAD
/api/v1/getUsers              # verb in URL
/api/v1/user                  # singular (use plural)
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add hashgraph-online/awesome-codex-plugins/api-design@sha256:d2b090c4319e030f

The line at the top of this page pins the label git:20260512.6523792, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

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

5 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on May 12, 2026.

version	committed	commit	size	audit
git:20260512.6523792 latest	2026-05-12	6523792	13,110 B	A	view

Audit of the latest version

A 17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the 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 (13110 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

hashgraph-online/awesome-codex-plugins · 1,501 stars · license Apache-2.0 · pushed 2026-11-03 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_6b3juawkbewq6mb4
GET https://markdownregistry.com/api/v1/resolve?ref=hashgraph-online/awesome-codex-plugins/api-design
GET https://markdownregistry.com/api/v1/blob/d2b090c4319e030fddb576950400724ff12ccb285083a540b6afb62431185d25

Your AI assistant 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.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from hashgraph-online/awesome-codex-plugins

AGENTS.md AGENTS.md file

hashgraph-online/awesome-codex-plugins · AGENTS.md

git:20261103.f1993d0 · audit A · 1,501 stars

ontoly-software-graph SKILL.md skill

hashgraph-online/awesome-codex-plugins · plugins/0xsarwagya/ontoly-codex-plugin/skills/ontoly-software-graph/SKILL.md · Use Ontoly Software Graph evidence, CLI reports, MCP, and official Ontoly Agent Skills before searching source files…

git:20260714.2040a1b · audit A · 1,501 stars

agent-debug-fixer SKILL.md skill

hashgraph-online/awesome-codex-plugins · plugins/1139030773-cmd/agent-workflow-system/skills/agent-debug-fixer/SKILL.md · 中文调试修复技能。用于报错、测试失败、页面异常、功能不符合预期、需要定位根因并做最小修复时。触发语包括"进入调试模式""帮我修问题""报错了""测试失败""页面坏了""找根因"。