net core Webapi基础工程搭建(三)——在线接口文档Swagger

  • 时间:
  • 浏览:3

前言

前后分离的好处,若果后端埋头做业务逻辑功能,不须要没有来越多考虑用户体验,只专注于数据、性能开发,对于前端须要的数据都可以通过组Json不可能 某些妙招回调,因此前后两端须要选择 好接口Api的规范,因此前端不可能 须要查看接口的相关信息,就须要文档的支撑了。没有 大问题来了,后端在开发过程中每次改动接口,都须要改动文档,累不累。

Swagger

Swagger作为有一一1个 在线文档,通日后端的接口控制器生成一套Json串数据,实时展示后端的接口请求地址,参数,类型以及回调,很好的避免你這個大问题(后端都可以给前端有一一1个 Swagger的地址,因此来句你本人看吧,当然还是须要多沟通的),你這個在Java里用过日后,就马上看看有没有 .net的版本,果真,语言都有相通的,废话没有来越多说,日后开始第三方类库的引用

NuGet引用第三方类库

工具->NuGet包管理器->管理避免方案的NuGet多多tcp连接 包...

浏览中查找"Swashbuckle.AspNetCore",选择 项目工程,点击安装。



引入完成后,在Startup.cs文件ConfigureServices中,加入以下代码:

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            
           #region Swagger
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info
                {
                    Version = "v1.1.0",
                    Title = "April WebAPI",
                    Description = "后台框架",
                    TermsOfService = "None",
                    Contact = new Contact { Name = "Blank", Email = "1829027193@qq.com", Url = "http://www.aprilblank.com" }
                });
            });
            #endregion 
        }

在Startup.cs类里编辑Configure妙招,加入以下代码:

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
           …
           
            #region Swagger
            app.UseSwagger();
            app.UseSwaggerUI(options =>
            {
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
            });
            #endregion

            app.UseHttpsRedirection();
            app.UseMvc();
        }

重新生成工程后,访我不知道的端口/swagger就都可以看多接口文档帮助界面了。

别急,还有

在线的接口文档是有了,可有一一1个 接口啥意思都我不知道,前端还是得一脸懵逼我不知道,你這個接口啥意思啊,你這個参数啥意思啊哪此的。

没错,注释

还是在Startup.cs文件ConfigureServices中,加入以下代码:

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            #region Swagger
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info
                {
                    Version = "v1.1.0",
                    Title = "April WebAPI",
                    Description = "后台框架",
                    TermsOfService = "None",
                    Contact = new Contact { Name = "Blank", Email = "790048789@qq.com", Url = "http://www.aprilblank.com" }
                });
                
                // 为 Swagger JSON and UI设置xml文档注释路径
                var basePath = Path.GetDirectoryName(AppContext.BaseDirectory);//获取应用多多tcp连接


所在目录(绝对,不受工作目录影响,建议采用此妙招获取路径)
                var xmlPath = Path.Combine(basePath, "April.xml");
                options.IncludeXmlComments(xmlPath);
                
            });
            #endregion
        }

右键WebApi你這個项目工程,点击属性,在生成你這個栏

先拿Values你這個控制器做实验



重新生成都有在对应目录看多有Apirl.xml文档文件,运行日后查看/Swagger



点开刚才单独注释参数的/api/Values/{id}

小结

有一一1个 WebApi工程离不开文档,而有一一1个 在线文档都可以省掉本人所以 事,因此Swagger也支持在线调试,虽说本人还是倾向于Postman(后续会介绍相关工具),你這個在线文档不仅是方便了前端查看,总之在开发上实在是有一一1个 利器。

下一篇,介绍后台核心之一,Log日志