Skip to content

Swagger

Niray Mak edited this page Jun 24, 2021 · 2 revisions

Swagger

About Swagger

Swagger is used as an API documentation tool, but it can be used to execute endpoint as well. DeX has Swagger available for both production and development environment.
The links for our production environments are below.
Staging Swagger
Production Swagger

Authorization

Some features are not implemented in our frontend yet. If it is desired to use the backend implementation (e.g. for posting new categories) you can use Swagger.

In most cases you will need to authorize. You can do this by following the steps below:

  1. Press the authorize button
    image

  2. Make sure to select the "dex-api" checkbox and press authorize again.

  3. You will be redirected to the IdentityServer. Choose to login with local or external (FHICT) account.

If you need administrator credentials you can contact the project lead.

Using Swagger

  1. Open the desired endpoint.
  2. Press "Try it out", in the top right corner.
  3. Enter the desired body.
  4. Press "Execute".

The response can be read below the execute button.