iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >Springboot集成swagger实现方式
  • 840
分享到

Springboot集成swagger实现方式

2024-04-02 19:04:59 840人浏览 独家记忆

Python 官方文档:入门教程 => 点击学习

摘要

swagger 提供了一个全新的维护 api 文档的方式,有4大优点: 自动生成文档:只需要少量的注解,Swagger 就可以根据代码自动生成 API 文档,很好的保证了文

swagger 提供了一个全新的维护 api 文档的方式,有4大优点:

  • 自动生成文档:只需要少量的注解,Swagger 就可以根据代码自动生成 API 文档,很好的保证了文档的时效性。
  • 跨语言性,支持 40 多种语言。
  • Swagger UI 呈现出来的是一份可交互式的 API 文档,我们可以直接在文档页面尝试 API 的调用,省去了准备复杂的调用参数的过程。
  • 还可以将文档规范导入相关的工具(例如 SoapUI), 这些工具将会为我们自动地创建自动化测试

如何实现swagger

一: pom文件加入依赖包


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

二:修改配置文件

1.application.properties 加入配置


#表示是否开启 Swagger,一般线上环境是关闭的
spring.swagger2.enabled=true

2.增加一个swagger配置类


@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Value(value = "${spring.swagger2.enabled}")
    private Boolean swaggerEnabled;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(swaggerEnabled)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.swagger.boot"))//包名代表需要生成接口文档的目录包。
                .paths(PathSelectors.any())
                .build();
    }
     private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description(" Spring Boot")
                .version("1.0")
                .build();
    }
}

以上就是SpringBoot集成swagger实现方式的详细内容,更多关于Springboot集成swagger的资料请关注编程网其它相关文章!

--结束END--

本文标题: Springboot集成swagger实现方式

本文链接: https://www.lsjlt.com/news/134170.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作