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

  • 时间:
  • 浏览:3
  • 来源:极速快3_快3规律_极速快3规律

前言

前后分离的好处,却说后端埋头做业务逻辑功能,不需用太久考虑用户体验,只专注于数据、性能开发,对于前端需用的数据都还都能否通过组Json否则 其他土办法回调,否则 前后两端需用选泽好接口Api的规范,否则 前端否则 需用查看接口的相关信息,就需用文档的支撑了。那末现象来了,后端在开发过程中每次改动接口,都需用改动文档,累不累。

Swagger

Swagger作为另另另1个在线文档,通事先端的接口控制器生成一套Json串数据,实时展示后端的接口请求地址,参数,类型以及回调,很好的处理这人现象(后端都还都能否给前端另另另1个Swagger的地址,否则 来句你另一方看吧,当然还是需用多沟通的),这人在Java里用过事先,就马上看看有那末.net的版本,居然,语言都有相通的,废话太久说,刚结速第三方类库的引用

NuGet引用第三方类库

工具->NuGet包管理器->管理处理方案的NuGet应用线程池池包...

浏览中查找"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);//获取应用应用线程池池所在目录(绝对,不受工作目录影响,建议采用此土办法获取路径)
                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日志