Swagger(一) 基础知识

一、什么是Swagger

Swagger 是一款RESTFUL接口的、基于YAML、JSON语言的文档在线自动生成、代码自动生成的工具。
号称世界上最流行的Api框架;
RestFul Api 文档在线自动生成工具
直接运行,可以在线测试API接口;
支持多种语言:(Java,Php…)
官网: https://swagger.io/

二、Swagger的作用

支持 API 自动生成同步的在线文档:使用 Swagger 后可以直接通过代码生成文档,不再需要自己手动编写接口文档了,对程序员来说非常方便,可以节约写文档的时间去学习新技术。
提供 Web 页面在线测试 API:光有文档还不够,Swagger 生成的文档还支持在线测试。参数和格式都定好了,直接在界面上输入参数对应的值即可在线测试接口。

三、为什么使用Swagger

前后端分离
Vue + SpringBoot
后端时代:前端只用管理静态页面;html==> 后端。模板引擎 JSP =>后端是主力
前后端分离式时代:
丶后端:后端控制层,服务层,数据访问层【后端团队】
丶前端:前端控制层,视图层【前段团队】
、伪造后端数据,json。已经存在了,不需要后端,前段工程依旧能够跑起来
丶前后端 如何交互?=====> API
、前段相对独立,松耦合;
。前段甚至可以部署在不同的服务器上;

问题:
前后端集成联调,前端人员和后端人员无法做到“及时协商,今早解决”,最终导致问题集中爆发;
解决方案:
首先指定schema【计划的提纲】,实时更新API,降低集成的风险;
早些年:指定word计划文档;
前后端分离:
前后端测试后端接口:postman
后端提供接口:需要实时更新最新的消息及改动!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

MW0309

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值