Endpoints

The Solidus API documentation is currently a work in progress.

If you want to quickly check for an API endpoint, you can do so locally.

First, ensure you are in your project directory:

Bash
    
      cd my_solidus_application

    
  

Then, you can filter a rails routes command using grep:

Bash
    
      bundle exec rails routes | grep '/api'

    
  

This command returns a list of every /api route that can reach your application. It includes the type of request (GET, POST, and so on) that each route accepts.

You can filter the list of routes being returned with more specific grep input:

Bash
    
      bundle exec rails routes | grep '/api/products'

    
  

Feedback

Solidus is an open source platform supported by the community. We encourage everyone using Solius to contribute back to the documentation and the code.

If you’re interested in contributing to the docs, get started with the contributing guidelines. If you see something that needs fixing and can’t do it yourself, please send us an email.