Skip to main content
Version: 15.0.1

Viewing the API documentation

The SODA server is a Flask application. The API is documented using Swagger. This page will cover viewing the Swagger documentation for the SODA server.

Prerequisites​

  • A working development environment (this can be achieved by following the Project Setup page instructions).
  • OR an installed copy of SODA for SPARC.

Viewing the API documentation​

The API documentation is generated using Swagger. To view the documentation:

  • Either run the development version of SODA or launch an installed copy of SODA.
  • Wait for the "Initializing SODA's background services" popup message to disappear (on Linux and Windows this message may only appear briefly).
  • Navigate to the following URL: http://localhost:4242/

You should now see the Swagger documentation for the SODA server.