Versions Compared

Old Version 3

changes.mady.by.user Rastislav Slota

Saved on

compared with

New Version 4

changes.mady.by.user Rastislav Slota

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The BimPlus API Swagger is accessible directly via the same url where API is deployed on DEV environment : https://api-dev.bimplus.net/swagger/index.html

BimPlus API Swagger configuration

The BimPlus API Swagger is configured in the following class : https://git.allplan.com/projects/SRVC/repos/api/browse/src/BimPlus.Server.Web/Program.cs

Image Added

...

Image Added

How it works

  • When initially invoking the Swagger url, it reads all XML document comments from all public methods representing API endpoints and generates "openapi" specification file (swagger.json)
  • This file serves as input for Swagger UI (that means Swagger UI doesn't dynamically reflect current source code but only shows a content of openapi spec. file generated out of current XML comments)