SpringFox

109 阅读 0 评论 72 点赞

我是靠谱客的博主妩媚手链，最近开发中收集的这篇文章主要介绍SpringFox，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

SpringFox可以自动为我们生成接口描述文档，提供控制层中各个请求的测试界面等.

pom.xml中加入依赖:

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

控制层使用注解:

@Controller
@Api(tags = "用户请求控制器")
public class UserController {
    @Autowired
    private UserService userService;
    // 向用户登录页面跳转
    @ApiOperation("向用户登录页面跳转")
    @GetMapping("/userLogin")
    public String toLoginPage(Model model) {
        model.addAttribute("hello","Hello");
        return "login";
    }


    @ApiOperation("获取用户信息")
    @ApiImplicitParam(name = "Id",value = "")
    @RequestMapping(value = "/getUser",method = RequestMethod.GET)
    public UserVo getUser(Long Id){
        UserVo userVo1=new UserVo(10001L,"Tom");
        UserVo userVo2=new UserVo(10002L,"Tom");
        Map<Long,UserVo> map=new HashMap<>();
        map.put(userVo1.getIdCard(),userVo1);
        map.put(userVo2.getIdCard(),userVo2);
        return map.get(Id);
    }

    @ApiIgnore
    @RequestMapping(value = "/ignored")
    @ResponseBody
    public String ignored(){
        return "ignored";
    }
}

@Api:用于Controller类上,对这个类进行说明;
@ApiOperation:用于Controller的方法中,对这个方法进行说明.
@ApiIgnore:用于类,方法,参数上,不对其生成说明信息.

查看生成的说明文档

访问localhost:项目端口/swagger-ui/index.html
在这里插入图片描述
可以看到自己写的UserController,点开可以看到其中的方法:

点开方法,可以看其参数,返回数据类型等:

测试Controller中的方法

点Try it out,输入需传入的参数,点击execute,即可查看参数结果:
在这里插入图片描述

对Controller方法的返回类型生成说明信息

比如对UserVo生成说明信息:

@AllArgsConstructor
@NoArgsConstructor
@Data
@ApiModel("个人信息")
public class UserVo {
    @ApiModelProperty("身份证号")
    private Long idCard;
    @ApiModelProperty("姓名")
    private String name;
    
}

@ApiModel:对model生成说明
@ApiModelProperty:对model的属性生成说明

getUser()方法的返回类型生成了其说明信息:
在这里插入图片描述

对Controller方法的参数生成说明信息

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）–> 请求参数的获取：@PathVariable
· body（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType=“Integer”
defaultValue：参数的默认值