springboot集成swagger-ui

最新推荐文章于 2023-12-18 17:57:12 发布

原创最新推荐文章于 2023-12-18 17:57:12 发布 · 209 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#springboot #swagger

java 专栏收录该内容

14 篇文章

订阅专栏

本文详细介绍了如何在SpringBoot项目中集成Swagger，包括引入依赖、配置Swagger并使用注解来生成API文档。通过具体步骤和代码示例，帮助开发者快速上手。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

记录软件开发点滴，积累知识和经验（第一篇）

要做什么？

目标：完成springboot集成swagger的功能。

怎样去做？

引入对应的jar(pom.xml)

 <!--  swagger-ui    -->
      <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(swagger2Config.java)

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wyl.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("简单优雅的restfun风格，http://blog.youkuaiyun.com/saytime")
                .termsOfServiceUrl("http://blog.youkuaiyun.com/saytime")
                .version("1.0")
                .build();
    }
}