ServiceStack Swagger UI and API version number

StackOverflow https://stackoverflow.com/questions/22224308

  •  10-06-2023
  •  | 
  •  

Question

Is there anyway to get the version number into the swagger UI?

So we can let developers know what version each deployment is at?

Was it helpful?

Solution

This is possible in the latest version of ServiceStack, you just set the ServiceStack API version in your AppHost thus :

public override void Configure(Container container)
{
     SetConfig(new HostConfig
     {
         ApiVersion = "1.1"
     });
{

This will then be picked up by the Swagger-Ui

OTHER TIPS

If you are looking to display the version for the API as a whole, there is support for this in Swagger UI as noted here. Additionally, this support made it into ServiceStack and will display properly on the bottom of the screen the same as the Swagger example.

Unfortunately, there isn't yet support for accessing the ApiVersion property in your code as seen here. This property isn't exposed in version 3 or 4 of ServiceStack or even in the new Model and Property filters on the Swagger feature. Accessing this would require a pull request to expose it.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top