使用API Blueprint创建API文档

本文介绍了如何使用API Blueprint进行API文档化,这是一种基于Markdown的标记语言,便于共享和编辑。通过工具如aglio生成静态HTML页面,并利用drakov进行冒烟测试。文章以Cloud Native Go书中的gogo-service示例讲解,详细阐述了从编写Markdown文档到生成文档和进行接口测试的流程。
摘要由CSDN通过智能技术生成

原文链接:http://rootsongjc.github.io/blogs/creating-api-document-with-api-blueprint/

在进行微服务开发的过程中,为了保证最终开发的系统跟最初的设计保持一致,约定RESTful接口之间的调用方法,我们需要将API设计文档化,因此我们引入了API Blueprint。

API Blueprint 是什么

API Blueprint 用来编写API文档的一种标记语言,类似于Markdown,因为是纯文本的,所以方便共享编辑,具体的语法规则可以在 API Blueprint documentation 查看,配合一些开源的工具可以把接口文档渲染成 html 再搭配一个静态服务器,方便于分享。

另外,配合一些工具,可以直接生成一个 mock data 数据,这样只要和后端的同学约定好接口格式,那么前端再开发的时候可以使用 mock data 数据来做测试,等到后端写好接口之后再做联调就可以了。

我们以

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值