How to set base path property in swagger?

170 Points

7 Posts

I have .NetCore Api application and integrated Swashbuckle.AspNetCore to generating swagger document. I want to set basePath something like:

{
    "swagger": "2.0",
    "info": {
        "version": "v1",
        "title": "ApiName.V1"
    },
    "host": "ApiUrl",
    "basePath": "/api",
    "paths": {
        "/": {
            "get": {
                "tags": [
                    "ApiName"
                ],
                .........

Is there any way to set custome basePath?

swashbuckle .netcore-3.1

Views: 9528
Total Answered: 1
Total Marked As Answer: 1
Posted On: 08-Mar-2021 04:13

Share:

Answers

Brian

2376 Points

13 Posts

Add following in startup.cs:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {

In Swagger v2.0 with OpenAPi 2.0:

var basepath = "/api";
c.PreSerializeFilters.Add((swaggerDoc, httpReq) => swaggerDoc.BasePath = basepath);


c.PreSerializeFilters.Add((swaggerDoc, httpReq) => {
    IDictionary<string, PathItem> paths = new Dictionary<string, PathItem>();
    foreach (var path in swaggerDoc.Paths)
    {
        paths.Add(path.Key.Replace(basepath, "/"), path.Value);
    }
    swaggerDoc.Paths = paths;
});

In v5 with OpenApi v3.0:

var basePath = "/api";
app.UseSwagger(c =>
    {
        c.RouteTemplate = "swagger/{documentName}/swagger.json";
        c.PreSerializeFilters.Add((swaggerDoc, httpReq) =>
        {
            swaggerDoc.Servers = new List<OpenApiServer> { new OpenApiServer { Url = $"{httpReq.Scheme}://{httpReq.Host.Value}{basePath}" } };
        });
    });

References:

Posted On: 09-Mar-2021 03:34