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

  • 时间:
  • 浏览:8
  • 来源:大发快3_快3网站_大发快3网站

前言

前后分离的好处,而是 后端埋头做业务逻辑功能,不时要太久考虑用户体验,只专注于数据、性能开发,对于前端时要的数据时要通过组Json事先一点最好的办法 回调,怎么让前后两端时要确定好接口Api的规范,怎么让前端事先时要查看接口的相关信息,就时要文档的支撑了。那么问提来了,后端在开发过程中每次改动接口,都时要改动文档,累不累。

Swagger

Swagger作为有有一一两个 在线文档,通事先端的接口控制器生成一套Json串数据,实时展示后端的接口请求地址,参数,类型以及回调,很好的出理 你是什么问提(后端时要给前端有有一一两个 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就时要看了接口文档帮助界面了。

别急,还有

在线的接口文档是有了,可有有一一两个 接口啥意思都真不知道,前端还是得一脸懵逼真不知道,你是什么接口啥意思啊,你是什么参数啥意思啊那些的。

没错,注释

还是在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}

小结

有有一一两个 WebApi工程离不开文档,而有有一一两个 在线文档时要省掉自己什么都事,怎么让Swagger也支持在线调试,虽说我自己还是倾向于Postman(后续会介绍相关工具),你是什么在线文档不仅是方便了前端查看,总之在开发上实在是有有一一两个 利器。

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