第九节:SpringBoot 在线文档 Swagger2 入门

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

package com.rumenz.lession9.controller.config;
import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.service.Contact;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;
/** * @className: Swagger2Config * @description: TODO 类描述 * @author: 入门小站 rumenz.com * @date: 2021/11/10 **/
@Configuration@EnableSwagger2 //Swagger2 3.0以下版本需要开启的注解public class Swagger2Config {
    @Bean    public Docket docket(){        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                .select()                .apis(RequestHandlerSelectors.basePackage("com.rumenz.lession9.controller"))                .paths(PathSelectors.any()).build();    }    private ApiInfo apiInfo(){        Contact contact=new Contact("入门小站", "https://rumenz.com", "xenry@163.com");        return new ApiInfoBuilder()                .title("入门小站接口文档")                .description("https://rumenz.com")                .contact(contact).build();    }}

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

package com.rumenz.lession9.controller.config;
import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.service.Contact;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;
/** * @className: Swagger2Config * @description: TODO 类描述 * @author: 入门小站 rumenz.com * @date: 2021/11/10 **/
@Configurationpublic class Swagger2Config {
    @Bean    public Docket docket(){        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                .select()                .apis(RequestHandlerSelectors.basePackage("com.rumenz.lession9.controller"))                .paths(PathSelectors.any()).build();    }    private ApiInfo apiInfo(){        Contact contact=new Contact("入门小站", "https://rumenz.com", "xenry@163.com");        return new ApiInfoBuilder()                .title("入门小站接口文档")                .description("https://rumenz.com")                .contact(contact).build();    }}

package com.rumenz;
import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import springfox.documentation.oas.annotations.EnableOpenApi;
@SpringBootApplication@EnableOpenApi //Swagger2 3.0以上版本需要开启的注解public class Lession9Application {
    public static void main(String[] args) {        SpringApplication.run(Lession9Application.class, args);    }
}

@Api(tags = "入门小站Controller入口",value = "页面上看不见的内容")

@ApiOperation(value = "方法的作用说明",notes = "方法的备注说明")

@ApiImplicitParams({@ApiImplicitParam(name = "page",value = "当前页"),@ApiImplicitParam(name = "pageSize",value = "分页大小")})

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

@ApiResponses({@ApiResponse(code = 200,message = "成功"),@ApiResponse(code=201,message = "参数错误")})

@ApiModel("用戶信息")

@ApiModelProperty(value = "名字",name = "name",example = "入门小站")

package com.rumenz.lession9.controller;
import io.swagger.annotations.*;import lombok.AllArgsConstructor;import lombok.Data;import lombok.NoArgsConstructor;import org.springframework.web.bind.annotation.*;
/** * @className: RumenzController * @description: TODO 类描述 * @author: 入门小站 rumenz.com * @date: 2021/11/10 **/@RestController@RequestMapping("/rumenz")//@Api用在类上,用于说明类功能的说明@Api(tags = "入门小站Controller入口",value = "页面上看不见的内容")public class RumenzController {
    @GetMapping("/index")    public String index(){        return "入门小站";    }
    @GetMapping("/user")    @ApiOperation(value = "方法的作用说明",notes = "方法的备注说明")    //传入参数说明    @ApiImplicitParams({@ApiImplicitParam(name = "page",value = "当前页"),@ApiImplicitParam(name = "pageSize",value = "分页大小")})    //说明请求返回的状态码及描述    @ApiResponses({@ApiResponse(code = 200,message = "成功"),@ApiResponse(code=201,message = "参数错误")})    public String index1(@ApiParam("页数") @RequestParam("page") Integer page,@ApiParam("每页条数") Integer pageSize){        return "入门小站";    }
    @PostMapping("/save")    @ApiOperation("保存用户")    public String save(@RequestBody User user){        return "入门小站";    }
}@Data@NoArgsConstructor@AllArgsConstructor//描述实体类@ApiModel("用戶信息")class User {    //描述实体类的属性    @ApiModelProperty(value = "名字",name = "name",example = "入门小站")    private String name;
    @ApiModelProperty(value = "年龄",name="age",example = "20")    private Integer age;
    @ApiModelProperty(value = "地址",name="address",example = "rumenz.com")    private String address;
    @ApiModelProperty(value = "邮箱",name="email",example = "372669319@qq.com")    private String email;
}