swagger

在 Spring Boot 中集成 Swagger 可参考之前的文章： Spring Boot 2 集成 Swagger , 在各个微服务中的配置与之相同；本文仅介绍在 Zuul 中的配置 在 Zuul 项目中添加配置 @Configuration @EnableSwagger2 public class SwaggerConfig { @Autowired ZuulProperties properties; @Primary @Bean public SwaggerResourcesProvider swaggerResourcesProvider() { return () -> { List<SwaggerResource> resources = new ArrayList<>(); properties.getRoutes().values().stream() .forEach(route -> resources .add(createResource(route.getServiceId(), route.getServiceId(), "2.0"))); return resources; }; } private SwaggerResource createResource(String name, String location, String

前言 swagger,中文“拽”的意思。它是一个功能强大的api框架，它的集成非常简单，不仅提供了在线文档的查阅， 而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api。 一、Swagger概述 Swagger是一组围绕OpenAPI规范构建的开源工具，可帮助设计、构建、记录和使用REST API。 简单说下，它的出现就是为了方便进行测试后台的restful形式的接口，实现动态的更新，当我们在后台的接口 修改了后，swagger可以实现自动的更新，而不需要认为的维护这个接口进行测试。 二、Swagger常用注解 swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。 @Api：修饰整个类，描述Controller的作用 @ApiOperation：描述一个类的一个方法，或者说一个接口 @ApiParam：单个参数描述 @ApiModel：用对象来接收参数 @ApiProperty：用对象接收参数时，描述对象的一个字段 @ApiResponse：HTTP响应其中1个描述 @ApiResponses：HTTP响应整体描述 @ApiIgnore：使用该注解忽略这个API @ApiError ：发生错误返回的信息 @ApiParamImplicitL：一个请求参数 @ApiParamsImplicit 多个请求参数 三