Versions Compared

Key

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

...

Adding conditional headers

In order to display required request headers in the Swagger UI (for example "Authorization" header that requires Bearer token to be used for secure calls) we can use [BimAuthenticate] attribute to decorate the API endpoint method.

See implementation here

https://git.allplan. in progresscom/projects/SRVC/repos/api/browse/src/BimPlus.Server.Web/Core/BimAuthenticate.cs

https://git.allplan.com/projects/SRVC/repos/api/browse/src/BimPlus.Server.Web/swagger/ConditionalHeaderParameter.cs


  • Here is an example of the attribute usage :

Image Added


  • and here is an example how it looks like in Swagger UI

Image Added

How to keep Swagger documentation up to date

...