【大道至简】NetCore3.1快速开发框架一:集成Swagger

≡放荡痞女 提交于 2020-05-02 08:28:04

在上一章节中,我们创建了基本的框架结构:https://www.cnblogs.com/fuyu-blog/p/12217647.html

下面我们测试接口和集成Swagger接口文档

 

一、接口测试

在默认创建的API中,大大和2.2不一样的是给了一个默认的接口示例,但不是Values了,变成了一个天气预报,【为什么呢~~~】

 

好吧,不管是Values还是天气预报,只要能运行起来,就是好大大

在Api项目右击,点击选择运行,或者在工具栏,点击运行-启动而不调试

 

自动会打开浏览器,运行成功

 

 下一步,我们自己新建的接口测试一下

在API项目中,Controller文件夹,右击新建文件

 

选择ASP.NET Core ——Web Api控制器类,输入一个自己写的名字,点击新建按钮

 

 这样一个简单的接口测试类就生成了

 

 生成项目F6

输入测试地址:https://localhost:5001/api/values    访问成功

 二、集成Swagger接口文档

在FytSoa.Api项目右击依赖项中,选择管理nuget包,并搜索Swashbuckle.AspNetCore包添加至引用 

 

 添加成功

 

 

在 Startup 类中 添加并配置 Swagger 中间件

public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "FytSoa API", Version = "v1" });
            });
        }

在 Startup.Configure 方法中,启用中间件为生成的 JSON 文档和 Swagger UI 提供服务

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "FytSoa API V1");
            });

            app.UseRouting();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }

生成FytSoa.Api项目并运行

输入网址:https://localhost:5001/swagger/index.html

接口文档集成成功

 附上微软地址:https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-3.1&tabs=visual-studio-mac

 

 下一章:集成Nlog日志管理

 

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!