Dev: REST Api & Swagger

Please make sure that you have completed the preparations presented here.

• Dev: Preperations

Introduction

The Express Server used provides a REST api.
All API endpoints are documented via Swagger and can be tested there.

Swagger

If you are in the development environment, you can access Swagger directly in the Develpoment module by clicking the GO TO SWAGGER DOCS button.
Alternatively, you can access Swagger manually via the following URL: http://{host}:{port}/api-docs/

• Host: localhost or adress to your server
• Port: 3001 (default)

REST Api

The REST Api itself can be accessed via the following URL: http://{host}:{port}/{basePath}

• Host: localhost or adress to your server
• Port: 3001 (default on dev) / 8800 (default on production)
• basePath: api/v1