千家信息网

springBoot2.0如何简单整合swagger

发表于:2024-12-01 作者:千家信息网编辑
千家信息网最后更新 2024年12月01日,这篇文章将为大家详细讲解有关springBoot2.0如何简单整合swagger ,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。废话不多说,从头开始学
千家信息网最后更新 2024年12月01日springBoot2.0如何简单整合swagger

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

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

  2. 添加pom依赖

                          io.springfox            springfox-swagger2            2.9.2                            io.springfox            springfox-swagger-ui            2.9.2        
  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@EnableSwagger2public 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;@RestControllerpublic class HelloController {    @GetMapping(value="/hello")    public Object hello() {        return "Hello Swagger-Ui!";    }}

5.启动项目,访问http://localhost:8080/swagger-ui.html效果如下:

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

0