使用Swashbuckle.AspNetCore生成.NetCore WEBAPI的接口文档

一、问题

  使用Swashbuckle.AspNetCore生成.NetCore WEBAPI的接口文档的方法

二、解决方案

  参考文章:https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/web-api-help-pages-using-swagger?tabs=visual-studio

  1、Install-Package Swashbuckle.AspNetCore

  2、在ConfigureServices中添加AddSwaggerGen。

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<TodoContext>(opt => opt.UseInMemoryDatabase("TodoList"));
    services.AddMvc();

    // Register the Swagger generator, defining one or more Swagger documents
      services.AddSwaggerGen(options =>
      {
                //options.DescribeAllEnumsAsStrings();
                options.SwaggerDoc("v1", new Swashbuckle.AspNetCore.Swagger.Info
                {
                    Title = "Azure Adapter Api - Catalog HTTP API",
                    Version = "v1",
                    Description = "The Catalog Microservice HTTP API. This is a Data-Driven/CRUD microservice sample",
                    TermsOfService = "Terms Of Service"
               });
      });
}

  3、在Configure中添加

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

三、运行测试:

  输入 http://127.0.0.1:8080/swagger/  或者 http://127.0.0.1:8080/swagger/v1/swagger.json

  

出处:https://www.cnblogs.com/songxingzhu/p/8599852.html

原文地址:https://www.cnblogs.com/mq0036/p/11138553.html

时间: 2024-10-12 20:25:24

使用Swashbuckle.AspNetCore生成.NetCore WEBAPI的接口文档的相关文章

asp.net core使用Swashbuckle.AspNetCore(swagger)生成接口文档

asp.net core中使用Swashbuckle.AspNetCore生成接口文档 Swashbuckle.AspNetCore:swagger的asp.net core实现,本文使用版本为v1.1.0项目地址:https://github.com/domaindrivendev/Swashbuckle.AspNetCore仔细看了下readme,发现在百度找半天的东西其实readme里面就有... 开局一张图,然后开始编,一些基本的asp.net core东西就不再赘述,本文只对Swash

给WebApi添加SwaggerUI,生成可交互接口文档

在ABP模板项目中,通过SwaggerUI可以为我们的WebApi生成动态的可交互接口文档页面,从而很方便的测试调用我们的WebApi接口. 1.集成Swagger 右键项目YoYo.Web,打开NuGet程序包管理器,添加Swashbuckle. 其中包含了程序和UI,安装后在App_Start文件夹下生成SwaggerConfig.cs. 完成这一步,Swagger已经集成完毕. 可以访问http://localhost:XXXX/swagger/ui/index. 如果出现异常,可以先尝试

Asp Net Core Swagger自动生成接口文档

Swagger是什么 Swagger工具为你的Asp Net Core生成漂亮的API文档.目前社会上大部分都是一个服务端为N个客户端提供接口,往往我们需要提供一个友好的API文档,Swagger的出现,几乎使得API文档完全自动化. 开始使用Swagger 此处我们使用开发IDE为VsCode,输入dotnet new webapi -o SwaggerDemo 创建ASP.NET Core Web API项目 添加Swashbuckle.AspNetCore包(此处不讨论包的安装方法,请自行

用Swagger生成接口文档

Swagger简介 在系统设计的时候,各个应用之间往往是通过接口进行交互的.因此接口的定义在整个团队中就变得尤为重要.我们可以把接口的规范用接口描述语言进行描述,然后Swagger可以根据我们定义的接口规范生成对应的接口文档.它生成的接口文档提供了接口测试功能.我们只需要填上对应的参数,然后点击调用,就可以完成一次接口测试,非常方便.就像下图展示的那样. 不仅如此,Swagger还能够根据接口规范自动生成对应的接口代码!比如Java客户端代码.Java服务端代码等.这个东西减少了接口规范的沟通成

用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档

博客搬到了fresky.github.io - Dawei XU,请各位看官挪步.最新的一篇是:用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档.

springmvc集成swagger实现接口文档自动化生成

一直苦于文档整理工作,因为这是一个很无聊的工作,偶然在网上看到了swagger这东西,感觉不错,于是动手集成了一下,眼前一亮 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步.Swagger 让部署管理和使用功能强大的API从未如此简单. 费话少说,下面来看一下集成的过程,我用的环境是:jdk1.8+tomc

开发接口文档--本接口文档是读取控制器方法上的注释自动生成的

本文档是参考网上的然后根据公司需要对代码进行了抽取和优化(主要是加了标题栏和对输出进行了格式化输出,更换呢了页面渲染方式(改为直接使用php进行渲染,原来的是使用了模板引擎),可读性较好),配置简单,读取方便,和项目耦合性较小,只需要将api_view这个文件夹放到和项目同级就可以使用,接口文档只有100多k大小 1.配置控制器 按照上图格式写接口方法注释(主是在控制器上面和方法上) 2.将接口文档放置在和项目同级 注:上面3个事项目,最下面的是接口文档 3.配置接口文档配置文件 api_vie

使用Swagger生成简单接口文档

使用swagger通过简单的配置可以生成简单的接口文档: 依赖包: // Swagger2 compile 'io.springfox:springfox-swagger2:2.8.0' compile 'io.springfox:springfox-swagger-ui:2.8.0' 启动类添加配置: import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.

接口文档自动生成工具apidoc

前后端分离之后,接口文档是前后端沟通的必要手段.然后接口文档包含大量的重复性工作,费时费力,像apidoc这样工具就十分必要了. 官方文档:http://apidocjs.com/ -------------------------------------------------------------------------------------------------- 首先说一下自己遇到的坑: 1.安装,node.js版本要高(在官网下最新的就行),不然后面有的模块会出问题,导致apid