How spscommerce/sps-api-standards works
This repository publishes SPS Commerce REST API design standards and a Spectral ruleset for linting OpenAPI specifications. The principal workflow is for API teams to consult the standards, provide an OpenAPI 3.x specification to Spectral, and validate it against the combined ruleset. The README documents the standards-to-ruleset relationship and linting workflow; source excerpts are limited to package metadata, so internal rule composition is not mapped in detail.
Main entry points: src Ruleset definitions · url-structure.md URL structure · request-response.md Requests and responses · naming.md Naming
Components 14
API Standards
- URL structure
standards/url-structure.md - Requests and responses
standards/request-response.md - Bulk operations
standards/bulk.md - Naming
standards/naming.md - Serialization
standards/serialization.md - Collections
standards/collections.md - Authentication
standards/authentication.md - Errors
standards/errors.md - Webhooks
standards/webhooks.md
Spectral Rules
- Ruleset definitions
rulesets/src - Combined ruleset
sps-api-standards.spectral.yml
Linting Workflow
- OpenAPI specification
- Spectral CLI
Other components
- API teams
Connections 21
- API teams → URL structure: consult
README.md - API teams → Requests and responses: consult
README.md - API teams → Bulk operations: consult
README.md - API teams → Naming: consult
README.md - API teams → Serialization: consult
README.md - API teams → Collections: consult
README.md - API teams → Authentication: consult
README.md - API teams → Errors: consult
README.md - API teams → Webhooks: consult
README.md - URL structure → Ruleset definitions: represented by
README.md - Requests and responses → Ruleset definitions: represented by
README.md - Naming → Ruleset definitions: represented by
README.md - Serialization → Ruleset definitions: represented by
README.md - Collections → Ruleset definitions: represented by
README.md - Authentication → Ruleset definitions: represented by
README.md - Errors → Ruleset definitions: represented by
README.md - Ruleset definitions → Combined ruleset: merged into
README.md - API teams → OpenAPI specification: design
README.md - API teams → Spectral CLI: run
README.md - OpenAPI specification → Spectral CLI: lint with
README.md - Spectral CLI → Combined ruleset: validate against
README.md