Api Design Framework

Name: Api Design Framework
Author: ArieGoldkin

ASecurity

REST, GraphQL, and gRPC API design — endpoint patterns, versioning (URL/header/content negotiation), error handling, pagination, authentication (JWT, OAuth2, API keys), and OpenAPI/AsyncAPI templates.

6 stars
0 votes
0 copies
1 view
Added September 6, 2026

ai-agentsgoapi

Works with

cursor
cli
api

Security analysis

A100/100

Pro scans all 4 files and shows the line behind each finding

Scanned September 6, 2026

npx -y skills add ArieGoldkin/claude-forge --skill api-design-framework --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Api Design Framework?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Api Design Framework

[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/ariegoldkin-api-design-framework/badge)](https://www.skillsdirectory.com/skills/ariegoldkin-api-design-framework)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro

SKILL.md

---
name: api-design-framework
description: REST, GraphQL, and gRPC API design — endpoint patterns, versioning (URL/header/content negotiation), error handling, pagination, authentication (JWT, OAuth2, API keys), and OpenAPI/AsyncAPI templates.
effort: low
paths:
  - "**/*api*"
  - "**/routes/**"
  - "**/endpoints/**"
  - "openapi.*"
---

# API Design Framework

## Workflow

1. **Choose protocol**: REST for CRUD resources, GraphQL for flexible client queries, gRPC for internal service-to-service
2. **Start from template**: Copy the relevant template below and customize
3. **Run checklist**: Validate against the design checklist before implementation

## Key Conventions

- URL versioning: `/api/v1/` prefix (not header-based)
- Resource naming: plural nouns, kebab-case (`/api/v1/care-plans`)
- Pagination: cursor-based for large collections, offset for small
- Auth: JWT Bearer tokens for APIs, API keys for service-to-service
- Errors: RFC 7807 Problem Details format

## Resources

- [OpenAPI Template](${CLAUDE_SKILL_DIR}/templates/openapi-template.yaml) - Starter OpenAPI 3.1 spec with reusable components
- [AsyncAPI Template](${CLAUDE_SKILL_DIR}/templates/asyncapi-template.yaml) - Starter AsyncAPI 3.0 spec for event-driven APIs
- [API Design Checklist](checklists/api-design-checklist.md) - Review checklist for API design