designing-http-apis SKILL.md skillA
designing-http-apis from dayfinggg/openai-codex-agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add dayfinggg/openai-codex-agent-skills/designing-http-apis@git:20261015.18f69f5Pins git:20261015.18f69f5 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- dayfinggg/openai-codex-agent-skills
- Path
codex/skills/designing-http-apis/SKILL.md- Versions recorded
- 1
- Latest version
- git:20261015.18f69f5, committed Oct 15, 2026
- Size
- 8,393 bytes
- Repository stars
- 8
- License
- MIT
Designs and reviews HTTP and REST JSON APIs by current standards for methods, status codes, errors, and OpenAPI contracts. Use when creating, changing, or reviewing endpoints, routes, controllers, request or response schemas, pagination, or OpenAPI specs.
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
# Designing HTTP APIs
An API is a contract that is expensive to change once clients depend on it, so design it for the client, keep it consistent, and evolve it without breaking callers. When the project already has API conventions or a style guide, follow them over this skill.
## Place in the architecture
The web is a delivery detail. Controllers parse and validate the request, call one use case, and map the result or error to an HTTP response. Business rules stay out of controllers, and request and response schemas are separate types from domain entities and database models, so the internal model can change without breaking clients. The applying-clean-architecture skill covers the layers.
## Resources and URLs
- Model nouns, not actions. Use plural collections and stable identifiers, as in `/orders` and `/orders/{orderId}`.
- Use lowercase kebab-case path segments. Nest at most one level for true ownership (`/orders/{orderId}/items`), and use filters for other relations.
- When an operation is not a natural create, read, update, or delete, model it as a sub-resource or an action endpoint, as in `POST /orders/{orderId}/cancel`, and keep such endpoints rare.
…Read the whole file at its exact version.
How to install
mdr add dayfinggg/openai-codex-agent-skills/designing-http-apis@sha256:265bc36302c7b916The line at the top of this page pins the label git:20261015.18f69f5, 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.
[](https://markdownregistry.com/a/art_ce2dothuhlny6fne)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Oct 15, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (8393 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
dayfinggg/openai-codex-agent-skills · 8 stars · license MIT · pushed 2026-10-15 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ce2dothuhlny6fne GET https://markdownregistry.com/api/v1/resolve?ref=dayfinggg/openai-codex-agent-skills/designing-http-apis GET https://markdownregistry.com/api/v1/blob/265bc36302c7b916dd323bd0cab60fd32bdcbfe3a42820858cc6730553cc0528
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.