欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

NetCore——Swagger

程序员文章站 2024-01-29 18:11:10
...

Swagger是来做什么用的呢?
就是现在普遍的前后端分离开发衍生而来的一种接口文档框架,使用者可以通过配置Swagger来对接口进行管理,以前往往后端开发人员开发接口接口文档往往跟不上更新迭代的速度,但是有了swagger大大简化了后端人员对接口文档维护的代价。
不说了下面来干货
1.首先NetCore现在都基于nuget包管理,先使用nuget安装swashbuckle.aspnetcore
NetCore——Swagger
2.然后再Startup.cs 中的ConfigureServices方法中添加容器NetCore——Swagger

  #region Swagger
            services.AddSwaggerGen(c =>
               {
                   c.SwaggerDoc("v1", new OpenApiInfo() { Version = "v1", Title = "Test"  });
                   var xmlPath = System.IO.Path.Combine(AppContext.BaseDirectory, "Jesus.Core.WebApi.xml");
                   c.IncludeXmlComments(xmlPath);
               }); 
            #endregion

3.再Startup.cs 中的Configure方法中使用swagger
NetCore——Swagger

 #region Swagger
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "CoreApi Docs");
            }); 
            #endregion

4.修改launchSettings.json
NetCore——Swagger

5.选择当前项目右键属性-生成
NetCore——Swagger
6.在这里插入代码片编译项目后,启动项目
NetCore——Swagger

相关标签: c#