Spring Boot整合Swagger2搭建在线文档

本文档详细介绍了如何在Spring Boot项目中整合Swagger2,创建在线API文档。从添加依赖、配置 Swagger2 到注解的使用,逐步讲解如何实现接口的文档化。最后展示了如何通过Swagger UI进行接口测试,包括Try it out功能。
摘要由CSDN通过智能技术生成

       Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 Restfull 风格的 Web 接口服务,在当前前后端分离的情况下,利用swagger搭建一个接口服务平台,接口服务平台可以减少一些前后台的不必要沟通,前端只需要根据接口便可以进行前端开发。

       这里swagger是在现有的一个springboot jpa工程上进行改造,现有的工程可以正常访问,在此基础上进行改造。

       下面一步步介绍下改造过程。

1、添加swagger依赖

在工程pom.xml文件中引入依赖,包括springfox-swagger2 和 springfox-swagger-ui 的依赖

		<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
		<dependency>
		    <groupId>io.springfox</groupId>
		    <artifactId>springfox-swagger-ui</artifactId>
		    <version>2.9.2</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
		<dependency>
		    <groupId>io.springfox</groupId>
		    <artifactId>springfox-swagger2</artifactId>
		    <version>2.9.2</version>
		</dependency>

2、配置swagger2

写一个配置类swagger2,在类的上方增加@Configuration注解,标注该类是一个配置类,增加@EnableSwagger2注解,开启swagger2的功能。在配置类swagger2中需要注入一个Docket的Bean,该Bean包含了api,即基本API的描述信息,以及包含描述的基本包名等信息。

package com.swagger.sw;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.P
  • 1
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值