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

  • 时间:
  • 浏览:0
  • 来源:大发快三_快三软件_大发快三软件

前言

前后分离的好处,已经 后端埋头做业务逻辑功能,不时需太少考虑用户体验,只专注于数据、性能开发,对于前端时需的数据前会 通过组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日志