Swagger使用

1. 导入pom依赖

   <!--swagger-->
   <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.9.2</version>
   </dependency>
   <!--swagger ui-->
   <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>1.9.2</version>
   </dependency>
   

2. Swagger自定义配置类

@Configuration//配置类
@EnableSwagger2//开启swagger2
public class Swagger2Config {
    @Bean//加入ioc容器
    public Docket adminApiConfig(){
        //需要详情配置
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("xxxApi")//swagger组的名字
                .apiInfo(adminApiInfo())
                .select()//必须有select扫描
                .paths(Predicates.and(PathSelectors.regex("/.*")))//默认路径是controller,因为它是api接口的入口
                .build();
        return docket;
    }

    private ApiInfo adminApiInfo(){

        return new ApiInfoBuilder()
                .title("xxx管理系统-API文档")
                .description("本文档描述了xxx管理系统接口")
                .version("1.0")
                .contact(new Contact("xxx", "http://baidu.com", "123@qq.com"))
                .build();
    }

}

3. 在controller的对应接口加上注解:@Api , @ApiOperation , @ApiParam

   @RestController
   @RequestMapping("/api/oss/file")
   @CrossOrigin
   @Api(tags = "阿里云文件管理")
   @Slf4j
   public class OssController {
   
       @Autowired
       private OssService ossService;
   
       @ApiOperation("文件上传")
       @PostMapping("/upload")
       public R upload(
               @ApiParam(value = "模块", required = true)
               @RequestParam("module") String module,
               @ApiParam(value = "文件",required = true)
               @RequestParam("file") MultipartFile file) {
   
           //获取file的流对象
           try {
               InputStream inputStream = file.getInputStream();
   
               //获取file的文件名
               String originalFilename = file.getOriginalFilename();
   
               //调用业务层
               String fileUrl = ossService.upload(inputStream, module, originalFilename);
   
               return R.ok().message(ResponseEnum.SUCCESS.getMessage()).data("fileUrl",fileUrl);
           } catch (IOException e) {
               e.printStackTrace();
               log.error(e.getMessage());
               return R.error().message(ResponseEnum.UPLOAD_ERROR.getMessage());
           }
       }
   }
   

访问http://localhost:8111/swagger-ui.html测试查看效果 端口号需要修改