欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Spring Boot Swagger2使用方法过程解析

程序员文章站 2022-03-07 12:43:42
1.添加swagger2依赖 io.springfox spr...

1.添加swagger2依赖

<dependency>
  <groupid>io.springfox</groupid>
  <artifactid>springfox-swagger2</artifactid>
  <version>2.2.2</version>
</dependency>
<dependency>
   <groupid>io.springfox</groupid>
  <artifactid>springfox-swagger-ui</artifactid>
  <version>2.2.2</version>
</dependency>

2配置类

@configuration
@enableswagger2
public class swagger2 {
  @bean
  public docket createrestapi() {
    return new docket(documentationtype.swagger_2)
        .apiinfo(apiinfo())
        .select()
        .apis(requesthandlerselectors.basepackage("com.bs.swaggertest.controller"))
        .paths(pathselectors.any())
        .build();
  }
  private apiinfo apiinfo() {
    return new apiinfobuilder()
        .title("微信项目接口对接文档")
        .description("测试环境接口调试")
        .contact("陶海军")
        .version("1.0")
        .build();
  }
}

3.添加文档内容

@restcontroller
@requestmapping(value="/users")
public class usercontroller {
  @apioperation(value="删除用户", notes="根据url的id来指定删除对象")
  @apiimplicitparam(name = "id", value = "用户id", required = true, datatype = "string")
  @requestmapping(value="/{id}", method=requestmethod.delete)
  public string deleteuser(@pathvariable string id) {
    return "success";
  }
}

4.测试

http://localhost:8080/swagger-ui.html

Spring Boot Swagger2使用方法过程解析

Spring Boot Swagger2使用方法过程解析

Spring Boot Swagger2使用方法过程解析

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。