swagger

在项目开发过程中，总会涉及到接口文档的设计编写，之前使用的都是ms office工具，不够漂亮也不直观，变更频繁的话维护成本也更高，及时性也是大问题。基于这个背景，下面介绍几个常用的API管理工具，方便你与调用方更高效的沟通测试： Swagger 官网地址：https://swagger.io Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件，是一个规范和完整的框架，标准的，语言无关，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。 目前最新版本是V3，SwaggerUI是一个简单的Restful API 测试和文档工具。简单、漂亮、易用。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。 RAP 官网地址：http://rapapi.org/org/index.do RAP来自阿里巴巴，是一个可视化接口管理工具 通过分析接口结构，使用mock动态生成模拟数据，校验真实接口正确性， 围绕接口定义，通过一系列自动化工具提升我们的协作效率。可以在线使用

1,引入依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> 2,建立配置 @Configuration @EnableSwagger2 public class Swagger { @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.yangliwei.bootlaunch")) .paths(PathSelectors.regex("/rest/.*")) .build(); } public ApiInfo apiInfo() { return new

这里写自定义目录标题 swagger的注解使用 类上的注解 方法的注解 参数注解 展示对象里面的字段注解 5.实体类的注释 swagger的注解使用 类上的注解 @Api(tags = “签到模块”) 在类上使用 效果如下： 方法的注解 @ApiOperation(value = “签到接口”, notes = “”) 方法上使用 参数注解 @RequestParam(required = true) @ApiParam(value = “用户id”, required = true) Integer userId 参数上使用 展示对象里面的字段注解 @ModelAttribute @Valid Check check 效果展示check对象的字段 5.实体类的注释 ApiModelProperty()用于实体类字段 表示对model属性的说明或者数据操作更改 　　value–字段说明 　　name–重写属性名字 　　dataType–重写属性类型 　　required–是否必填 　　example–举例说明 　　hidden–隐藏 3 对接口和实体类添加注释，生成doc。常用的标记如下 @Api()用于类； 标识这个类是swagger的资源 　　tags–表示分组说明标签 @ApiOperation()用于方法； 表示一个http请求的操作 　　value用于方法描述 　

微服务项目学习之Swagger 什么是Swagger Swagger是全球最大的OpenAPI规范（OAS）API开发工具框架，支持从设计和文档到测试和部署的整个API生命周 期的开发。 Swagger官方网站 Swagger的常用注解 在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下： @Api：修饰整个类，描述Controller的作用 @ApiOperation：描述一个类的一个方法，或者说一个接口 @ApiParam：单个参数描述 @ApiModel：用对象来接收参数 @ApiModelProperty：用对象接收参数时，描述对象的一个字段 @ApiResponse：HTTP响应其中1个描述 @ApiResponses：HTTP响应整体描述 @ApiIgnore：使用 该注解忽略这个API @ApiError ：发生错误返回的信息 @ApiImplicitParam：一个请求参数 @ApiImplicitParams：多个请求参数 @Api属性： 属性 描述 value url的路径值 tags 设置这个值、value的值会被覆盖 description 对api资源的描述 basePath 基本路径可以不配置 position 如果配置多个Api 想改变显示的顺序位置 produces For example,

本文包括两个部分： webapi中使用swagger 修改webapi的路由和默认参数 WebApi中使用swagger 项目打开之后，选择 引用，右键，管理NuGet程序包 浏览，搜索swagger，选择第一个swashbuckle，安装 安装好之后，右键项目，选择属性，生成，在下面的输出那里勾选：XML文档文件，如果没有自动填充好路径，需要自己填写一下，文件名可以自己 打开App_Start文件夹下的SwaggerConfig.cs文件，新增一个如下方法： private static string GetXmlCommentsPath() { return System.String.Format(@"{0}\bin\Coldairarrow.WebApi.xml", System.AppDomain.CurrentDomain.BaseDirectory); } 搜索GetXmlCommentsPath，下面能搜到已经注释了，自己把注释放开，要是没搜到，就自己手动写一下c.IncludeXmlComments(GetXmlCommentsPath());注意要写在register方法里面 运行项目，在根路径后面直接加swagger，就会自动跳转到文档，如：http://localhost:13520/swagger/ui/index，能看到我们写的一些注释 来源：

前言 随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要， swagger 就是一款让你更好的书写API文档的框架。 安装 首先，创建WebApi类型的项目 TestSwagger 2. 安装Swashbuckle 包和swagger.Net.UI包 　　3. 安装完成之后，可以看到这些类与文件都是安装完成时swagger添加的 设置 设置输出xml文档文件 右键项目属性—>生成—>勾选XML文档文件 运行 发生上述错误，请在，SwaggerNet.cs中，注释类上面的两行 结果又报以下错误： 这时需要在SwaggerConfig.cs 文件中 GlobalConfiguration.Configuration.EnableSwagger 添加c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First()); 需要添加注释则加： c.IncludeXmlComments(string.Format("{0}/bin/TestService.XML", System.AppDomain.CurrentDomain