api-design SKILL.md skillA

api-design from lynricsy/hyperskills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add lynricsy/hyperskills/api-design@v2026.10.15

Pins v2026.10.15 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: lynricsy/hyperskills
Path: skills/api-design/SKILL.md
Versions recorded: 5
Latest version: v2026.10.15, committed Oct 15, 2026
First version recorded: Sep 10, 2026
Size: 18,173 bytes
Repository stars: 25
License: MIT

Designs REST API contracts, resource models, pagination and OpenAPI specifications.

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

## Scope

The contract an HTTP API exposes, and nothing about how it is implemented. Resource
modelling, URIs, methods, status codes, representation shape, collections and their
pagination, the error contract, concurrency and caching headers, long-running operations,
versioning, compatibility judgement, deprecation, and the OpenAPI document that states all
of it.

Applies whether the contract is new, being redesigned, or being reviewed before a release.

Not covered:

- Implementing the contract — routers, handlers, validation wiring, serialisers, dependency
  injection, ORM access, tests of the implementation. Use the `fastapi`,
  `nodejs-backend`, `java-spring`, `csharp-dotnet` or `laravel` skill; this skill decides
  what the wire contract is, those decide how a stack produces it.
- GraphQL schema design, operations, and federation — use the `graphql` skill. The two do
  not overlap: HTTP contracts here, GraphQL there.
- Reviewing a diff or a pull request for general correctness — use the `code-review` skill,
  and come back here for the contract rules a reviewer applies to an API change.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add lynricsy/hyperskills/api-design@sha256:490bcb7a962a6a80

The line at the top of this page pins the label v2026.10.15, 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_dkqkwtwit6k2edtn.svg)](https://markdownregistry.com/a/art_dkqkwtwit6k2edtn)

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

Versions

The registry has recorded 5 versions of this file, between Sep 10, 2026 and Oct 15, 2026, about one every 9 days.

version	committed	commit	size	audit
v2026.10.15 latest	2026-10-15	75d934c	18,173 B	A	view · diff
v2026.09.30	2026-09-30	4beac4d	18,173 B	A	view · diff
v2026.09.29	2026-09-29	ff986f1	18,173 B	A	view · diff
v2026.09.12	2026-09-12	c70620f	18,173 B	A	view · diff
v2026.09.11	2026-09-10	e5b1c26	19,083 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 (18173 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

lynricsy/hyperskills · 25 stars · license MIT · pushed 2026-11-01 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_dkqkwtwit6k2edtn
GET https://markdownregistry.com/api/v1/resolve?ref=lynricsy/hyperskills/api-design
GET https://markdownregistry.com/api/v1/blob/490bcb7a962a6a8023645bd00a3851c8ba5eb3dbea3ad1c7a070f66d4a8fcdf1

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 lynricsy/hyperskills

AGENTS.md AGENTS.md file

lynricsy/hyperskills · AGENTS.md

git:20261015.8cec18e · audit A · 25 stars

ai-engineering SKILL.md skill

lynricsy/hyperskills · skills/ai-engineering/SKILL.md · Builds LLM apps: prompts, tool-using agents, RAG context and evals; not vector-index tuning.