api-design SKILL.md skillA

This file is byte-identical to the first copy the registry indexed. Same content hash, so the same checks give both the same grade.

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

Install it, pinned
mdr add projanvil/mindforge/api-design@git:20261016.6f8a292

Pins git:20261016.6f8a292 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
projanvil/mindforge
Path
plugins/mindforge-en/skills/api-design/SKILL.md
Versions recorded
1
Latest version
git:20261016.6f8a292, committed Oct 16, 2026
Size
15,069 bytes
Repository stars
3
License
MIT

Professional API design skill covering RESTful APIs, GraphQL, API versioning, authentication, idempotency, and API documentation best practices. Use this skill when designing RESTful APIs, creating GraphQL schemas, implementing API versioning strategies, or need guidance on authentication, error handling, and API documentation.

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 Skill - System Prompt

You are an expert API architect with 15+ years of experience in designing robust, scalable, and developer-friendly APIs. You specialize in RESTful API design, GraphQL, API versioning, authentication/authorization, and API security best practices.

## When to Use

Trigger scenarios — use this skill when the user asks to:

- Design or review REST / GraphQL APIs
- Design API versioning, pagination, error formats, or rate limiting
- Write OpenAPI specs or API documentation

## Your Expertise

### Core API Disciplines
- **RESTful API Design**: Resource modeling, URI design, HTTP method selection, HATEOAS
- **GraphQL Design**: Schema design, resolver patterns, query optimization, federation
- **API Versioning**: URI versioning, header versioning, backward compatibility strategies
- **Idempotency**: Idempotency key patterns, distributed locking, state machine design
- **Authentication/Authorization**: OAuth 2.0, JWT, API keys, RBAC/ABAC, fine-grained permissions
- **Error Handling**: Unified error responses, error code design, internationalization
- **API Documentation**: OpenAPI/Swagger, examples, changelog, developer portal
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add projanvil/mindforge/api-design@sha256:bdaecc1f214e6981

The line at the top of this page pins the label git:20261016.6f8a292, 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 badge

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

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

Versions

The registry has recorded 1 version of this file, committed on Oct 16, 2026.

versioncommittedcommitsizeaudit
git:20261016.6f8a292 latest2026-10-16 6f8a292 15,069 BA 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 (15069 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

projanvil/mindforge · 3 stars · license MIT · pushed 2026-10-21 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_iiit4e36x2kbodsp
GET https://markdownregistry.com/api/v1/resolve?ref=projanvil/mindforge/api-design
GET https://markdownregistry.com/api/v1/blob/bdaecc1f214e69811e908172824ec66ebb1025a5bd1b1e7ca6f1e497386b2e93

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 projanvil/mindforge

database-design SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/database-design/SKILL.md · Database design and optimization skill covering ER diagrams, normalization, indexing, sharding, query optimization, and…
git:20261016.6f8a292 · audit A · 3 stars
design-pattern SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/design-pattern/SKILL.md · Expert knowledge in software design patterns covering GoF patterns, architectural patterns, and modern design…
git:20261016.6f8a292 · audit A · 3 stars
enterprise-java SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/enterprise-java/SKILL.md · Enterprise Java development skill covering Spring ecosystem, microservices, design patterns, performance optimization…
git:20261016.6f8a292 · audit A · 3 stars
frontend-react SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/frontend-react/SKILL.md · Professional React development skill covering Next.js, React Server Components, Tailwind CSS, and the React ecosystem…
git:20261016.6f8a292 · audit A · 3 stars
frontend-svelte SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/frontend-svelte/SKILL.md · Professional frontend development skill covering Svelte, SvelteKit, shadcn-svelte, and Bun ecosystem. Use this skill…
git:20261016.6f8a292 · audit B · 3 stars
frontend-vue SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/frontend-vue/SKILL.md · Professional Vue.js development skill covering Nuxt 3, Vue 3 Composition API, Tailwind CSS, and the Vue ecosystem. Use…
git:20261016.6f8a292 · audit B · 3 stars
git-guru SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/git-guru/SKILL.md · Expert Git skills covering interactive rebase, worktree management, reflog recovery, bisect debugging, advanced…
git:20261016.6f8a292 · audit A · 3 stars
go-development SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/go-development/SKILL.md · Go language development skill focusing on Fiber web framework, Cobra CLI, GORM ORM, Clean Architecture, and concurrent…
git:20261016.6f8a292 · audit A · 3 stars
javascript-typescript SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/javascript-typescript/SKILL.md · Professional JavaScript and TypeScript development skill covering modern ES6+, TypeScript, Node.js, Express, React…
git:20261016.6f8a292 · audit A · 3 stars
product-management SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/product-management/SKILL.md · Expertise in product management lifecycle, from ideation to launch. Covers requirements gathering, user story creation…
git:20261016.6f8a292 · audit A · 3 stars
python-development SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/python-development/SKILL.md · Professional Python development skill covering modern Python 3.10+, FastAPI, Django, Flask, async programming, data…
git:20261016.6f8a292 · audit A · 3 stars
session-summary SKILL.md skill
projanvil/mindforge · plugins/mindforge-en/skills/session-summary/SKILL.md · Skill for summarizing the current session's context, including completed tasks, technical decisions, and next steps…
git:20261016.6f8a292 · audit A · 3 stars

Every file in projanvil/mindforge

Other files named api-design

api-design SKILL.md skill
affaan-m/ecc · docs/es/skills/api-design/SKILL.md · Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de…
git:20260607.ac0f11c · audit A · 284,510 stars
api-design SKILL.md skill
affaan-m/ecc · .agents/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260918.c752aac · audit A · 284,510 stars
api-design SKILL.md skill
affaan-m/ecc · .kiro/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260323.535120d · audit A · 284,510 stars
api-design SKILL.md skill
affaan-m/ecc · docs/ja-JP/skills/api-design/SKILL.md · リソース命名、ステータス コード、ページネーション、フィルタリング、エラー応答、バージョン管理、およびレート制限を含む REST API デザイン パターン。
git:20260517.ec9ace9 · audit A · 284,510 stars
api-design SKILL.md skill
cbrock84/headcount · plugins/technology/skills/api-design/SKILL.md · Designs interfaces that survive their consumers — resource modeling, errors, versioning, pagination, and compatibility…
git:20260916.e72e404 · audit A · 2,076 stars
api-design SKILL.md skill
hashgraph-online/awesome-codex-plugins · plugins/Colin4k1024/tsp/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260512.6523792 · audit A · 1,352 stars
api-design SKILL.md skill
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
v2.0.0 · audit A · 296 stars
api-design SKILL.md skill
yonatangross/orchestkit · src/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
v2.0.0 · audit A · 296 stars

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