Swagger

本文介绍了使用VUE和SpringBoot实现前后端分离,并通过Swagger进行API交互与文档生成。详细讲解了Swagger的配置和使用,包括设置页面信息、指定扫描包、协同开发以及实体类配置。通过Swagger,开发者可以方便地进行前后端联调和文档维护。
摘要由CSDN通过智能技术生成

 前后端分离:VUE+springboot

1.职责

1)后端:后端控制层,服务层,数据访问 即controller,service,mapper

2)前端:前端控制层,视图层

      前端通过数据伪造,依然正常执行项目

2.交互方式

通过API(应用程序接口)交互,松耦合

这样做产生一个问题:前后端集成联调,无法做到有问题及时解决

3.简介

1)Swagger:世界上最流行的api框架

2)在线运行

3)Restful  在线文档自动生成   api文档和api接口同步更新

swagger官网:API Documentation & Design Tools for Teams | Swagger

二.springboot项目集成swagger

1.创建springboot项目

2.导入swagger坐标依赖

3.创建applicaiotn.yml和controller文件

4.配置swagger-config

创建一个配置类,加上两个@Configuration,@EnableSwagger2 的注释即可

 5.访问swagger即可,地址:localhost:8080/swagger-ui.html

Swagger UI

三. 配置Swagger,

1).设置展示页面信息

 2)配置swagger的扫描,主要是指定扫描的包       docket(摘要)

这里是加上了多环境扫描,用profiles类调用of方法,将"dev,test放进去

3)swagger协同开发:创建多个Docket,那么在swagger界面就能展示多个成员的接口

4)实体类配置: 即页面上的model and view

@Api注解汇总

    1.@ApiModel:注解实体类

     2.@ApiModelProperty 注解实体类的属性

     3.@ApiOperation 加在接口的方法上,即Controller接口

    4.@ApiParam  放在接口方法的形参上,用于注释形参

四:应用,进入swagger页面后,打开对应的controller,输入参数点击execute执行,之后可以在下方界面得到返回值

文章写的不够详细,了解也不够深入,后续会继续改正!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值