API文档工具swagger-简单说

现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,

前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架。

API文档工具前世今生

没有API文档工具之前,大家都是手写API文档的,在什么地方书写的都有,有在confluence(wike)上写的,有在对应的项目目录下readme.md上写的,

高端点的还有用阿里的RAP  

 github地址为:https://github.com/thx/RAP   

部署文档https://github.com/thx/RAP/wiki/deploy_manual_cn


swagger

rap挺好的,但是和swagger比起来有点轻量。 


下面再细看看swagger的生态的具体内容:

swagger-ui

swagger-editor

就是一个在线编辑文档说明文件(swagger.json或swagger.yaml文件)的工具,以方便生态中的其他小工具(swagger-ui)等使用。 
左边编辑,右边立马就显示出编辑内容来。 
这里写图片描述

编辑swagger说明文件使用的是yaml语法


swagger-codegen

代码生成器,脚手架。可以根据swagger.json或者swagger.yml文件生成指定的计算机语言指定框架的代码。






评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值