springboot集成Swagger 3.0

springboot集成Swagger 3.0

Swagger介绍

Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。

添加依赖

<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version></dependency>

开启swagger

在springboot的启动类型添加注解 @EnableOpenApi

@SpringBootApplication@EnableOpenApipublicclassProjectTestUserApplication{publicstaticvoidmain(String[] args){SpringApplication.run(ProjectTestUserApplication.class, args);}}

配置

packagecom.example.user.Utils;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importorg.springframework.stereotype.Component;importspringfox.documentation.builders.RequestHandlerSelectors;importspringfox.documentation.spi.DocumentationType;importspringfox.documentation.spring.web.plugins.Docket;@ConfigurationpublicclassSwaggerConfig{@BeanpublicDocketcreateRestApi(){returnnewDocket(DocumentationType.OAS_30).select().apis(RequestHandlerSelectors.basePackage("com.example.user.controller")).build();}}

访问swagger

直接访问http://ip:端口/swagger-ui/

swagger 常用注解

1. @Api 类注解,在控制类添加此注解,可以对控制器类进行功能说明
2. @ApiOperation 方法注解：说明接口方法的作用
3. @ApiImplicitParams和@ApiImplicitParam 在 Rest 接口方法上使用来指定请求参数
4. @ApiParam 是注解api的参数，用于swagger提供开发者文档，文档中生成的注释内容

@RequestMapping("/userController")@RestController@Api(value ="用户")publicclassUserController{@AutowiredprivateUserFeign userFeign;/**
     * 获取参数
     * @return
     */@ApiOperation(value ="查询用户")@ApiImplicitParams({@ApiImplicitParam(dataType ="string",name ="name",value ="用户名")})@GetMapping("userShow")publicList<UserCommon>userShow(@ApiParam(value ="用户名",required =true)@RequestBodyUserVo userCommon){return  userFeign.show();}}

1. @ApiIgnore 可以用在类、方法上，方法参数中，用来屏蔽某些接口或参数，使其不在页面上显示。
2. @ApiModel 类注解,在返回和参数实体类添加此注解,可以对返回和参数实体类进行说明
3. @ApiModelProperty 参数注解

@ApiModel("用户vo")@DatapublicclassUserVo{privateint id;@ApiModelProperty(value ="编号")privateString  name;@ApiModelProperty(value ="年龄")privateint age;}

参数的详细介绍可以看此作者，写的较为详细添加链接描述