个人管理后台制作(6)-集成swagger

个人管理后台制作

介绍

最受欢迎的API文档规范之一是OpenApi，以前称为Swagger。  
它允许您使用JSON或YAML元数据描述API的属性。它还提供了一个Web UI，它可以将元数据转换为一个很好的HTML文档。
通过该UI，您不仅可以浏览有关API端点的信息，还可以将UI用作REST客户端 - 您可以调用任何端点，指定要发送的数据并检查响应。
手动编写此类文档并在代码更改时保持更新是不现实的。这就是SpringFox发挥作用的地方。
它是Spring Framework的Swagger集成。它可以自动检查您的类，检测控制器，它们的方法，它们使用的模型类以及它们映射到的URL。
没有任何手写文档，只需检查应用程序中的类，它就可以生成大量有关API的信息。

引用

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

创建swagger配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.zhang.pms"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot 使用 Swagger2 构建RESTful API")
                //创建人
                .contact(new Contact("张建军", "http://localhost:8888/", ""))
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

测试

@Api("用户操作接口")
@RestController("/platform/user")
public class UserController {

    @ApiOperation(value = "获取所有用户", notes="获取所有用户资料")
    @PostMapping("/getAllUsers")
    public Result getAllUsers(){
        Result result = new  Result();
        result.setData("aaaaaaaaaaa");
        return result;
    }
}

启动项目，访问地址：http://localhost:8888/swagger-ui.html

注释说明（后续更新）

@Api() :用于类上，tag：分组，value：描述类
@ApiOperation：用户方法上。value：方法的描述，notes：实施说明