Skip to content

Dev: REST Api & Swagger

borsTiHD edited this page Jul 31, 2021 · 5 revisions

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

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: your server address
  • Port: 3001 (default)
Clone this wiki locally