API contains the controllers and rabl views implementing the REST API of Solidus.
Run the API tests:
bundle exec rspec
The API documentation is in the openapi directory. It follows the OpenAPI specification and it is hosted on Stoplight Docs.
If you want to contribute, you can use Stoplight Studio. Simply follow these steps:
- Create a new Stoplight Studio project
- Copy-paste the content of
openapi/api.oas2.yml
into your project - Edit the endpoints and models as needed
- Copy-paste the result back into
openapi/api.oas2.yml
- Open a PR!
Note: Only use embedded models in Stoplight Studio, as Stoplight Docs is not compatible with externally-defined models!
CircleCI automatically syncs our Git repo with Stoplight Docs when a PR is merged, and automatically publishes a new version on Docs when a new Solidus version is released.