SpringBoot整合Swagger2

最新推荐文章于 2024-09-13 22:23:10 发布

灬一幕

最新推荐文章于 2024-09-13 22:23:10 发布

阅读量144

点赞数

分类专栏： java 文章标签： java spring boot

本文链接：https://blog.csdn.net/weixin_45782384/article/details/111908499

版权

java 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

本文介绍了如何在SpringBoot项目中整合Swagger2，通过添加Maven坐标、编写Swagger工具类，以及在Controller接口和请求体上使用相关注解，实现API的文档化。启动程序后，可以访问Swagger UI进行接口测试。

摘要由CSDN通过智能技术生成

Maven坐标

<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
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cn.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("简单优雅的restfun风格")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}