rest-api-standards

To enforce RESTful API design, this Skill mandates spec-first development, OpenAPI 3.0+ compliance, and Spectral linting. It ensures your API development follows consistent standards for versioning, error handling, and security schemes.

Spec-first development requires defining your OpenAPI specification before implementing code. This approach is needed when designing new microservices to ensure API contracts adhere to established standards for versioning, pagination, and rate limits.

Standardizing error handling and API versioning requires defining clear versioning strategies in paths and maintaining consistent error response formats within your OpenAPI specification. This Skill enforces those specific constraints during API design.

Yes, adhering to these REST API standards requires linting your OpenAPI 3.0+ specifications with Spectral. This validates that your API design enforces required security schemes, traceability, and pagination rules before implementation.

Yes, you can use this Skill when designing a new microservice API to guide the creation of its OpenAPI specification. It ensures adherence to company-wide standards for error responses, security schemes, and API versioning.