servers support for multiple base path

[subhransus2]

Hi
I just want to add multiple base path in swagger doc.
For ex :
My base path is /api/v1
I have defined two tags(let say A and B)

1. Endpoints under tag A will have url like

localhost:8080/api/v1/getList

2. Endpoints under tag B will have url like

localhost:8080/api/v1/sub/getList

I can do this by adding @router /sub/getList [post], but it is not a best practice for adding /sub in all endpoints. So I am searching for solutions like define basepath for particular tags or override the global base path.

Or is there any way of adding servers like following:

"servers": [
    {
      "url": "https://localhost:8080/api/v1/"
    },
    {
      "url": "https://localhost:8080/api/v1/sub/"
    }
  ],

[sdghchj]

I am afraid this is no way

[subhransus2]

Is there any other feasible solution to resolve this?

[sdghchj]

I think your had better first to find out whether swagger2.0 supports multiple base paths. If not, all here make no sense.

[subhransus2]

I don't think swagger 2.0 supports multiple base paths. But if we can add servers like following then I guess it will be better as per my requirement.
This way we need to select the required path from the dropdown.

servers:
  - url: https://api.example.com/v1
    description: Production server (uses live data)
  - url: https://sandbox-api.example.com:8443/v1
    description: Sandbox server (uses test data)

[sdghchj]

Sorry, I haven't got your idea.
Does swagger UI supoort it ?

[subhransus2]

You can check this out
https://swagger.io/docs/specification/api-host-and-base-path/

[sdghchj]

I see.
However I found tag 'servers' is suported in openapi 3.0.0 but swag for swagger 2.0

[subhransus2]

Yes.
Is there any plan to release and update to support Open API spec 3.0?

[sdghchj]

@easonlin404

[ubogdan]

@subhransus2 so far for this use case, we have support for controlling hostname/schema at runtime, please check this example.
Open API 2.0 doesn't have support for multiple endpoints definition.

servers:
  - url: https://api.example.com/v1
    description: Production server (uses live data)
  - url: https://sandbox-api.example.com:8443/v1
    description: Sandbox server (uses test data)

https://swagger.io/docs/specification/2-0/api-host-and-base-path/

[Nerzal]

We should definetly take a look at Open API 3.0 in the near future.
There are several great features to solve problems like this easily :)

[smithyj]

强烈支持大佬执行 3.0 升级计划

[ubogdan]

Closing: The generated swag documentation allows configurable Host and Basepath.

[Nerzal]

Host and Basepath was not the answer to the issue :)

Use the @x-servers extension annotation for that feature.

[matanmarciano]

Host and Basepath was not the answer to the issue :)

Use the @x-servers extension annotation for that feature.

Can you give an example how to do that?