api-design

This skill provides structured API design guidance for resource modeling, authentication, versioning, and error handling to build scalable REST and GraphQL APIs that are easy to document and maintain.

The best way to document OpenAPI specifications and GraphQL schemas is to apply best-practice design guidance during resource modeling. This ensures accurate communication with frontend and integration partners by maintaining consistent API naming and documentation.

Refactoring existing endpoints requires applying structured operation design, versioning plans, and authentication strategies. This improves consistency and maintainability by aligning your REST and GraphQL endpoints with established API best practices.

Yes, this approach applies to both REST and GraphQL ecosystems. It provides guidance on designing authentication strategies, resource modeling, and pagination across both architectures to improve overall API consistency and quality.

You need a structured approach for API resource modeling and naming when creating a new domain API or refactoring an existing one. It helps satisfy requirements for versioning, error handling, pagination, and OpenAPI documentation to prevent scalability issues.