Swagger框架:使用swagger自动生成API

本文介绍了在巴斯夫公司BCG项目中如何利用Swagger框架为SpringBoot+Spring Security+JWT+MyBatis项目生成API文档。通过注解方式,Swagger能自动生成API详情,包括输入参数、访问路径和响应参数,简化了前后端沟通和接口文档编写。整合Swagger的步骤包括添加依赖、配置信息、处理拦截问题以及在Controller层添加注解。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

项目情况:

         最近开的项目是巴斯夫公司的BCG项目,项目的后台框架阶段我选择了Swagger框架来实现API的生成。

         该项目的后台技术框架有:SpringBoot+Spring Security+JWT+MyBatis+Swagger+POI

Swagger介绍:

         个人感觉Swagger相当的方便,通过注解的方式将Controller层的方法自动生成到swagger-ui.html中,在该页面可以看到输入参数的格式、访问路径、返回的响应参数等。与postman类似,但比postman方便一点。而且前后端分离的情况下,后台代码发布到服务器上就可以让前端开发查看到swagger-ui.html。这样每次后台修改过代码之后,代码一发布,前端就可以看到最新的接口信息,省去了写wiki之类的时间。

项目整合Swagger框架步骤:

    第一步:添加相关依赖:

<!--swagger框架-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.6.0</version>
</dependency>

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.6.0</version>
</dependency>

   第二步:建立配置类,添加配置信息(这里我添加的请求头Authorization是由于我使用了jwt框架首先登陆校验,需要swagger能够发送token信息)

package com.handlecar.basf_bcg_service.conf;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springf
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值