关于Swagger2使用的总结

这个感觉更像是一个网页版的postman 所以针对的是对controller层的作用

首先导入依赖:这个是一个springboot项目

<dependency>

            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>2.2.2.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.2.2.RELEASE</version>
        </dependency>
        <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>

然后写配置类

@Configuration
@EnableSwagger2//一定要加这个注解 否则会进不去出不来那个swagger界面
public class SwaggerConfig {

    private String name;
    private String url;
    private String email;

    @Bean
    public Docket docket(ApiInfo apiInfo){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select().apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    @Bean
    public ApiInfo apiInfo(){
       return new ApiInfoBuilder()
                .title("这个是稳定标题")
                .contact(new Contact(name, url, email))//联系方式
                .license("版本号")//这个是许可 没啥用
                .licenseUrl("版本号地址")
                .build();
    }

}

里面的名字什么的在配置文件中写 然后用@value注解引用过来 如果需要的话

@RestController
@Api(description = "订单管理api",value = "订单管理")
public class SwaggerController {

    @RequestMapping("/test")
    @ApiOperation(value = "测试接口")
    public String test(@ApiParam(name = "这个是哪里的名字",
            defaultValue = "{\"这个是干嘛的\":\"默认值\"}",
            value = "测试方法" ,required = true)
                           @RequestParam String param){
        return "这个是一个测试"+param;
    }

}

然后是controll层的书写 这个是里面的描述注解 需要注意的是如果不加@RequestParam 在界面就不会出现默认值 一会用红色圈住

之后启动类 页面输入

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

可以看到页面

如果用@getmapping注解 出现的就只有get方法

点开get方法就出现如下界面 点击右上角try 字段 就可以操作了 感觉是多此一举的感觉 有这个时间直接用postman好了