apiary.io是一个帮助设计API的网站,其可以实现以交互方式设计RESTful API,其是一个支持API Blueprint Markdown语法的所见即所得的编辑器。Apiary可以生成返回JSON有效数据的模拟服务器,这样节省了必须自己搭建模拟服务器的时间。使用Apiary也可以支持通过保持API First的方式,直到完成制定API的草稿阶段。
首先打开apiary.io网站:
可以通过github账号登录。
之后新建一个名为"test"的API Blueprint,可以看到:
上图左边的编辑栏可以用markdown语法编写API文档,右边是展示的实时效果(可以通过点击右上角preview弹出)。
文档里包括了API的url,提交和返回的数据,对数据的说明等。
当点击Save后,点击Documentation
之后显示下图的界面,其包含了当前API Blueprint所拥有的API列表。
点击后可以看到具体的API内容:
可以看到测试的结果:
可以通过http客户端给之前得到的url发送http请求。
访问url不存在的页面:
访问url存在的页面(http://private-1221c9-test22515.apiary-mock.com/questions):
Apiary也有inspector功能可以监控收到的API请求:
通过Apiary,可以很方便地通过markdown方式编写API蓝图,允许其他开发人员快速获得所有服务的REST资源,URI模式和请求/响应有效载荷的列表。也可以在此API蓝图的基础上进行后续的前端开发(可以在过程中减少对后端的依赖)。