springBoot2.0如何简单整合swagger

发布时间:2021-09-29 17:52:27 作者:柒染
来源:亿速云 阅读:117

这篇文章将为大家详细讲解有关springBoot2.0如何简单整合swagger ,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。

  1. 废话不多说,从头开始学做项目,由于项目定的技术是前后端分离,后端使用restful,所以选用Swagger-Ui来做接口测试工具,用法很简单,总的来说第一步:在POM文件中添加依赖、第二步,编写Swagger-Ui配置类,并注入到spring容器中,下面是具体实现步骤

  2. 添加pom依赖

      <!--swagger-->
        <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>
  1. 在项目中新建程序启动入口,新建config包,在包config中新建SwaggerConfig

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder().build();
    }

}

4.建个包名字为controller ,在包中HelloController供测试使用

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping(value="/hello")
    public Object hello() {
        return "Hello Swagger-Ui!";
    }

}

5.启动项目,访问http://localhost:8080/swagger-ui.html效果如下: springBoot2.0如何简单整合swagger

关于springBoot2.0如何简单整合swagger 就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。

推荐阅读:
  1. SpringBoot2.0 整合 Swagger2 ,构建接口管理界面
  2. springboot如何整合swagger

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

springboot swagger

上一篇:springboot caffine缓存的简介及demo是怎样的

下一篇:常用的shell脚本有哪些

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》