SpringBoot整合Swagger

原创

日落西风又在吹 2022-01-10 17:41:16 ©著作权

文章标签 spring ui界面单元测试 文章分类 代码人生

©著作权归作者所有：来自51CTO博客作者日落西风又在吹的原创作品，请联系作者获取转载授权，否则将追究法律责任

@Author:SimpleWu

什么是Swagger？

Swagger是什么：THE WORLD’S MOST POPULAR API TOOLING

根据官网的介绍：

Swagger Inspector：测试API和生成OpenAPI的开发工具。Swagger Inspector的建立是为了解决开发者的三个主要目标。

执行简单的API测试
生成OpenAPI文档
探索新的API功能

我的理解Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。简单来说，Swagger是一个功能强大的接口管理工具，并且提供了多种编程语言的前后端分离解决方案。根据我的使用，当然我只是最简单的使用，我感觉Swagger有以下几个优点：

Swagger可以整合到代码中，在开发时通过注解，编写注释，自动生成API文档。

将前端后台分开，不会有过分的依赖。

界面清晰，无论是editor的实时展示还是ui的展示都十分人性化，如果自己仅仅用markdown来编写，又要纠结该如何展现，十分痛苦。

构建项目

step1.导入依赖

    <!--swagger服务api构建个性包-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.6.1</version>
    </dependency>
    <!--swagger ui界面-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.6.1</version>
    </dependency>
    <!--springboot web服务-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!--springboot单元测试-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

step2.编写swagger配置类

想要使用swagger功能必须提供配置类，主要配置ui界面信息，以及配置扫描位置，swagger会根据配置的路径扫描所有的服务生成api。

其中核心RequestHandlerSelectors.basePackage("com.simple.spring.boot.controller"),在这里配置我们的需要的扫描包位置。

@Configuration

@EnableSwagger2

public class SwaggerConfig {

@Bean

public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())

            .select()

            .apis(RequestHandlerSelectors.basePackage("com.simple.spring.boot.controller"))

            .paths(PathSelectors.any()).build();

}

private ApiInfo apiInfo() {

    return new ApiInfoBuilder()

        .title("Spring Boot中使用Swagger2构建RESTful APIs")

        .description("myapp")

        .termsOfServiceUrl
        .version("1.0").build();

    }

}

step3.编写springboot启动类

@ComponentScan(basePackages={"com.simple.spring.boot.controller"}) 也是需要配置扫描路径。

@SpringBootApplication
@ComponentScan(basePackages={"com.simple.spring.boot.controller"})  
public class SwaggerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SwaggerApplication.class, args);
    }
}

step4.创建前端控制器

@RestController
@Api(tags = "swgger测试服务", description = "swgger测试服务")
@RequestMapping(value = "/simple/wu")
public class TestController {

    @ApiOperation(value="测试POST方法", notes="测试POST方法")
    @ApiImplicitParam(name = "令牌", value = "ID", required = true, dataType = "token")
    @RequestMapping(value="hello", method=RequestMethod.POST)
    public String post(@RequestBody String token) {
        books.put(book.getId(), book);
        return "success";
    }
}

@Api(tags = "swgger测试服务", description = "swgger测试服务") 指定某个类提供服务的名字
@ApiOperation(value="测试POST方法", notes="测试POST方法") 指定某个请求的名字
@ApiImplicitParam(name = "令牌", value = "token", required = true, dataType = "String")指定名字对应参数为令牌，以及对应参数字段token，required = true代表这个参数为必填参数，dataType 代表数据类型。