项目中整合swagger2

文章目录

• 前言
• 一、Swagger2是什么？
• 二、使用步骤
  • 1.引入pom.xml文件的依赖
  • 2.配置swagger
• 三、使用方法总结

---

前言

    记录

---

提示：以下是本篇文章正文内容，下面案例可供参考

一、Swagger2是什么？

          Swagger2是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful 风格的Web 服务。

二、使用步骤

1.引入pom.xml文件的依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.4.0</version>
  </dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.4.0</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.6</version>
</dependency>

2.配置swagger

@Configuration
@EnableSwagger2
public class Swagger2 {
    //http://localhost:8088/swagger-ui.html  源路径
    //http://localhost:8088/doc.html     swagger-bootstrap-ui路径

    @Bean
    //配置swagger2核心配置 docket
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)   //指定API类型为swagger2
          .apiInfo(apiInfo())                            //用于定义api文档汇总信息
          .select().apis(RequestHandlerSelectors
                        .basePackage("com.imooc.controller")) //指定controller 包
                        .paths(PathSelectors.any())          //所有controller
                        .build();
    }
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("电商平台接口api")    //文档页标题
                .contact(new Contact("XARQL",
                                     "dd",
                                     "3365243477@qq.com"))  //联系人信息
                .description("专为天天吃货提供的api文档")  //详细信息
                .version("1.0.1")   //文档版本号
                .termsOfServiceUrl("dd")       //网站地址
                .build();
    }
}

访问路径：

http://localhost:8088/swagger-ui.html                       源路径

http://localhost:8088/doc.html swagger-bootstrap-ui   路径

---

• 使用方法总结

• @ApiIgnore 
•  标注的Controller 不展示（ignore 忽略）

• ---

  @Api(value = “注册登陆”,tags = “注册登陆的相关接口”) 

•   这个注释添加到要展示的controller类上

• ---

  @ApiOperation(value = “用户名是否存在”,notes = “用户名是否存在”,httpMethod = “GET”) 主要放置在方法前边，用于展示对应接口的信息，以及请求方式；

• ---

  @ApiModel(value = “用户对象BO”, description = “从客户端，由用户传入的数据封装在此entity中”)
• 这个主要是放在BO类上（BO类在这个项目就是为了接收参数的封装类）

• ---

  @ApiModelProperty(value = “用户名”,name = “usernmae”,example = “imooc”,required = true)
• 这个主要是放在BO类中的属性前边，用于描述具体参数信息