api-designer

Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.

1.00x

Quality

100%

Does it follow best practices?

Impact

98%

1.00x

Average score across 6 eval scenarios

Securityby

Passed

No known issues

Evaluation results

100%

Product Catalog API Design

REST resource design and OpenAPI 3.1 specification

Criteria

Without context

With context

OpenAPI version 3.1

100%

Plural resource names

100%

No verbs in URIs

100%

Correct POST status code

100%

Location header on create

100%

Correct DELETE status code

100%

Pagination on collections

100%

has_more in pagination response

57%

100%

operationId on all operations

100%

Tags on operations

100%

Reusable components

100%

Examples provided

100%

Security scheme documented

100%

Error responses documented

100%

Payment API Error Handling Specification

Error handling design and validation patterns

Criteria

Without context

With context

Machine-readable error codes

100%

RFC 7807 or structured format

100%

Field-level validation details

100%

Request ID in errors

100%

Correct HTTP status codes

100%

Rate limit headers

100%

Retry guidance

100%

No implementation details exposed

100%

Error code catalog

100%

Reusable OpenAPI error responses

100%

503 retry-after header

100%

Actionable error messages

100%

Customer API v2 Migration Planning

API versioning and deprecation lifecycle

Criteria

Without context

With context

URI versioning chosen

100%

Major versions only

100%

Deprecation header

100%

Sunset header

100%

Successor link header

100%

410 Gone after sunset

100%

Migration guide with breaking changes

100%

OpenAPI v2 URL structure

100%

Deprecation timeline

100%

No version in field names

100%

OpenAPI 3.1 format

100%

Communication channels listed

100%

Activity Feed API Design

Cursor-based pagination with limits

Criteria

Without context

With context

Cursor parameter used

100%

next_cursor in response

100%

has_more in response

100%

Default limit 20

100%

Maximum limit 100

100%

OpenAPI 3.1

100%

Pagination on all collections

100%

Bearer auth documented

100%

Rate limit response

100%

Reusable pagination schema

100%

Cursor pagination rationale

100%

Limit values stated

100%

92%

Healthcare Patient Portal API Design

Consistent naming conventions and resource modeling

Criteria

Without context

With context

Entity diagram exists

100%

Single naming convention

100%

Naming convention declared

100%

Plural resource collections

100%

No deep nesting

100%

No verbs in URIs

100%

OpenAPI 3.1

100%

Correct POST/DELETE status codes

100%

Pagination on collections

100%

Reusable components

100%

HATEOAS links

Request/response examples

100%

Error responses documented

100%

Payment Processing API Design

Tooling validation, idempotency, and complete API deliverables

Criteria

Without context

With context

Entity diagram produced

100%

OpenAPI 3.1

100%

Redocly lint used

100%

Lint passes

100%

Prism mock script

100%

Idempotency-Key header

100%

Pagination on payment list

100%

Rate limit response

100%

Auth flow documented

100%

Error catalog in design doc

100%

Versioning strategy documented

100%

Duplicate handling explained

100%

operationId on all operations

100%

Repository: jeffallan/claude-skills
Commit: 5b76101

Evaluated: 28 days ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

Product Catalog API Design Payment API Error Handling Specification Customer API v2 Migration Planning Activity Feed API Design Healthcare Patient Portal API Design Payment Processing API Design

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.