Connect

API Designer

majiayu000bymajiayu000
•
594
•
API Development

Architects scalable REST and GraphQL APIs with comprehensive OpenAPI 3.1 specifications, resource modeling, and standardized error handling.

The API Designer skill serves as a senior API architect to help plan, structure, and document developer-friendly REST and GraphQL APIs. It guides the creation of production-grade OpenAPI 3.1 specifications, resource relationships, consistent URI conventions, robust pagination and filtering strategies, API versioning lifecycles, and RFC 7807 compliant error handling, ensuring consistent, secure, and maintainable backend API contracts.

Key Features

01594 GitHub stars
02RESTful resource modeling, URI design, and HTTP method mapping
03Standardized pagination, filtering, and sorting patterns
04API versioning, lifecycle deprecation, and backward compatibility planning
05OpenAPI 3.1 specification generation in YAML and JSON formats
06RFC 7807 compliant error handling and HTTP status code catalogs

Use Cases

01Drafting production-ready OpenAPI 3.1 specs for client SDK generation and interactive documentation
02Standardizing enterprise API patterns across versioning, pagination, and error responses
03Designing and documenting new REST or GraphQL API contracts before implementation