.NET WebApi 配置 Swagger

我会带着你远行 2021-06-26 16:06 473阅读 0赞

今天移动开发端搭建了一个RAP2平台，之前与移动端配合的几个WebApi项目都是以postman的json文件对接的，现在得改成`Swagger`对接到RAP2平台上去了。之前倒是也解过`Swagger`，不过也没有在正式项目中用过，这次就好好学习一下吧！

### .NET Framework 项目配置 `Swagger` ###

#### 第一步Nuget引用 `Swashbuckle`包 ####

![在这里插入图片描述][20210620144439277.PNG]

#### 第二步 属性设置 ####

点击项目名称，右键属性，选择生成，勾选XML文档文件，记住文档文件名称，下一步要用到  
![在这里插入图片描述][20210620144455510.PNG]

#### 第三步 引用完包后在App\_Start中会生成一个 `SwaggerConfig.cs` 文件 ####

![在这里插入图片描述][20210620144514144.PNG]

打开`SwaggerConfig`文件，会发现好多注释掉的代码，全部删除掉留下，将上一步的文档名称配置进去

public class SwaggerConfig
        { 
            public static void Register()
            { 
                var thisAssembly = typeof(SwaggerConfig).Assembly;
                GlobalConfiguration.Configuration
                    .EnableSwagger(c =>
                        { 
                            c.SingleApiVersion("v1", "SwaggerF");//版本号+项目名称
                            var webApiXmlPath = string.Format("{0}/bin/SwaggerF.xml", System.AppDomain.CurrentDomain.BaseDirectory);//配置生成路径
                            c.IncludeXmlComments(webApiXmlPath);
                            
                        })
                    .EnableSwaggerUi(c =>
                        { 
                           
                        });
            }
        }

#### 第四步 运行项目 ####

项目运行后访问 https://localhost:44348/swagger 就可以看到接口页面了  
![在这里插入图片描述][20210620144545208.PNG]

发布后将 `https://localhost:44348/swagger/docs/v1` 交给RAP2系统管理员就OK了

### .NETCORE 项目配置 `Swagger` ###

#### 第一步Nuget引用 `Swashbuckle.AspNetCore`包 ####

![在这里插入图片描述][20210620144612490.PNG]

#### 第二步 属性设置 ####

点击项目名称，右键属性，选择生成，勾选XML文档文件，记住文档文件名称

![在这里插入图片描述][20210620144633582.PNG]

#### 第三步 项目配置 ####

在`Startup`文件中按如下配置服务和中间件

**ConfigureServices**

services.AddSwaggerGen(c =>
                { 
                    c.SwaggerDoc("v1", new OpenApiInfo {  Title = "MyApi", Version = "v1" });
                    var xmlPath = Path.Combine(AppContext.BaseDirectory, "Swagger.xml");
                    c.IncludeXmlComments(xmlPath);
                });

**Configure**

app.UseSwagger(c => {  c.RouteTemplate = "swagger/{documentName}/swagger.json"; });
        app.UseSwaggerUI(c =>
        { 
            c.SwaggerEndpoint("v1/swagger.json", "Swagger");
        });

#### 第四步 运行项目 ####

项目运行后访问 `https://localhost:44322/swagger/` 就可以看到接口页面了

![在这里插入图片描述][20210620144804480.PNG]

[20210620144439277.PNG]: /images/20210626/d3f9d9ee936f4a03bae8d0b10da386f6.png
[20210620144455510.PNG]: /images/20210626/94ac8dfc70714bb2b865dbe42ac5bf44.png
[20210620144514144.PNG]: /images/20210626/6ec0db233e764e7ea864c3e89c01f6a0.png
[20210620144545208.PNG]: /images/20210626/3250a25b536b4304a457b5b0fd909df5.png
[20210620144612490.PNG]: /images/20210626/93b3584d48db44e7bf565bd34e5693fd.png
[20210620144633582.PNG]: /images/20210626/9fcf0e4027c14e49b643ba522b47a4f0.png
[20210620144804480.PNG]: /images/20210626/4cb2d7872ffb4939bc0e3c243e05af5c.png