swagger使用说明：

    • 添加依赖
    • 配备config类
      • @Configuration & @EnableSwagger2
      • 在config类中设置向Bean管理器中添加一个 Docket 对象
        • DocumentationType.SWAGGER_2 -> 其他的 DocumentationType 还包括 SWAGGER_12 & SWAGGER_WEB 所以要标准清楚
        • apiInfo 设置 swagger 信息
        • select() & paths() 设置扫描包
    • 配置完成之后通过访问 http://localhost:端口号/swagger-ui.html 来访问接口测试页面

    Api描述文件

    常用注解

    • @Api( tags, description )
      • 用于类（controller？），用于向该controller添加说明
      • ElementType.TYPE -＞　用于接口、类、枚举、注解
    • @ApiOperation
      • @Target({ElementType.METHOD})
      • 用于向方法添加说明
    • @ApiPrama
      • 用于向方法的参数添加说明
    • @ApiIgnore
    • @ApiModel
      • 用于实体类 -> 接受数据的实体类，对类进行说明
    • @ApiModelProperty
      • 用于实体类的方法字段
      • 对model的属性补充说明

    @Target 注解的目标 @Target(ElementType.TYPE) //接口、类、枚举、注解 @Target(ElementType.FIELD) //字段、枚举的常量 @Target(ElementType.METHOD) //方法 @Target(ElementType.PARAMETER) //方法参数 @Target(ElementType.CONSTRUCTOR) //构造函数 @Target(ElementType.LOCAL_VARIABLE)//局部变量 @Target(ElementType.ANNOTATION_TYPE)//注解 @Target(ElementType.PACKAGE) ///包

    Swagger & Postman 对比：

    • Postman：可以将请求保测试时的参数保存下来，对整个测试的过程来说非常的方便；而Postman还可以在 header 保存 token 信息，那么在测试涉及到权限要求的时候就也是非常方便
    • swagger：swagger 的测试文档信息是写在代码中的，在与前端对接的时候前端人员可以直接看到测试文档，比较方便