南瓜慢说官方网站

  • 首页
  • 所有文章
  • 容器技术
  • SpringBoot-Cloud
  • 程序人生
  • 其它
  • 整理
  • 关于

  • 搜索
中间件 config Go Private Kubernetes pkslow Test HTTPS Redis Docker Mac 计划 Stream MongoDB Spring DevOps JVM String Map Set List 性能 Email Springboot 集合类 ArrayList Java
技术之前,先读诗书:

Springboot整合Swagger

发表于 2020-07-21 | 分类于 Springboot | 0 | 阅读次数 231

问题

前后端分离后,接口文档显得十分重要,调试也是,Swagger为我们提供了一个有用的功能。自动把端口以网页形式展示出来。

使用官方方式

只要两步即可:

(1)添加依赖

<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>

(2)启动注解

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

完成以上两步即可,启动Springboot应用,访问:http://localhost:8080/swagger-ui.html

使用SpringForAll封装后的依赖

在该项目的帮助下,我们的Spring Boot可以轻松的引入swagger2:

  • 在pom.xml中引入依赖:
<dependency>
	<groupId>com.spring4all</groupId>
	<artifactId>swagger-spring-boot-starter</artifactId>
	<version>1.9.1.RELEASE</version>
</dependency>
  • 在应用主类中增加@EnableSwagger2Doc注解
@EnableSwagger2Doc
@SpringBootApplication
public class Bootstrap {
    public static void main(String[] args) {
        SpringApplication.run(Bootstrap.class, args);
    }
}

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

GibHub网址:https://github.com/SpringForAll/spring-boot-starter-swagger

总结

更多丰富的用法,就参考官方文档吧。


欢迎关注微信公众号<南瓜慢说>,将持续为你更新...

file

推荐阅读:
如何制定切实可行的计划并好好执行
容器技术(Docker-Kubernetes)
SpringBoot-Cloud相关
Https专题

  • 本文作者: 南瓜慢说
  • 本文链接: https://www.pkslow.com/archives/springboot-swagger
  • 版权声明: 本博客所有文章除特别声明外,不可转载!
# 中间件 # config # Go # Private # Kubernetes # pkslow # Test # HTTPS # Redis # Docker # Mac # 计划 # Stream # MongoDB # Spring # DevOps # JVM # String # Map # Set # List # 性能 # Email # Springboot # 集合类 # ArrayList # Java
中间件 config Go Private Kubernetes pkslow Test HTTPS Redis Docker Mac 计划 Stream MongoDB Spring DevOps JVM String Map Set List 性能 Email Springboot 集合类 ArrayList Java
打不死的小强,让Docker的容器自动重启
如何部署ReactJs打包后的build目录文件
  • 文章目录
  • 站点概览
南瓜慢说

南瓜慢说

多年Java开发,主要专注后端技术:Java/Spring/Springboot/微服务/大数据等。

多读书,多分享;多写作,多整理。

151 日志
7 分类
27 标签
RSS
0%
© 2020 — 2021 南瓜慢说 本站已挣扎运行:   粤ICP备20036375号