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 Docs directly over the sidebar by clicking the Swagger Docs link.
Alternatively, you can access Swagger manually via the following URL: http://{host}:{port}/api-docs/

• Host: localhost or remote adress/ip
• Port: 3001 (default: 3001, or DEV_PORT_BACKEND value set in .env)

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: 3001 on dev) / 8800 (default: 8800 on production)
• basePath: api/v1