欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

SpringBoot 使用 swagger2 构建在线接口文档

程序员文章站 2022-07-02 21:13:46
...

简介

编写和维护接口文档是每个程序员的职责,根据 Swagger2 可以快速帮助我们编写最新的 API 接口文档,间接提升了团队开发的沟通效率。

一、pom.xml 依赖

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.8.0.RELEASE</version>
</dependency>

二、在应用主类增加 @EnableSwagger2Doc 注解

@SpringBootApplication
@MapperScan("com.springboot.mybatis.mapper")
@EnableSwagger2Doc
public class SpringBootMybatisApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootApplication.class, args);
    }

}

默认情况下就能产生所有当前 SpringMVC 加载的请求映射文档。

访问地址:http://localhost:8080/swagger-ui.html

三、在配置文件中添加 swagger2 配置

#swagger配置
swagger.enabled=true
swagger.title=spring-boot-mybatis module api
swagger.description=Starter for swagger 2.x
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=(此处自行填写name)
swagger.contact.url=(此处自行填写url地址)
swagger.contact.email=(此处自行填写email)
swagger.base-package=com.springboot.mybatis.controller
swagger.base-path=/**
swagger.exclude-path=/error, /ops/**

SpringBoot 使用 swagger2 构建在线接口文档
详情点这里

上一篇: Python_递归

下一篇: 安卓存储资源