API蓝图 - API设计工具

2021-05-13 04:27:14

API Blueprint很简​​单,每个人都涉及Apifecycle的每个人都可以访问。它的语法简洁又表达。使用API​​蓝图,您可以创建或将原型API设计和原型API,并测试已销售任务关键API。

API蓝图是建立在Apifecycle中的任何一点之间的应用程序,开发人员和客户之间的对话和协作。与此同时,API蓝图工具提供了支持的支持,目标是API开发,治理或交付。

API蓝图在麻省理工学院许可证下完全开放。利用未来是透明的,open.api蓝图不需要一个封闭的工作组。相反,它使用类似于Rust语言或Django增强建议RFC进程的RFCProcess。

API蓝图语言由GitHub识别。在GitHub上搜索API蓝图:" API蓝图"询问。

API蓝图的媒体类型为Text / VND.APIBluePrint,并且审查文件扩展名为.apib。如果使用此扩展,Github上的kyBluePrint将获得语法突出显示。

构建API蓝图以鼓励通过抽象鼓励更好的API设计。API蓝图的目标是分离API的元素,以启用模块化封装后端实现行为。

#data structures ##博客帖子(对象)+ ID:42(数字,必填)+文本:Hello World(String)+作者(作者) - 博客文章的作者。 ##作者(对象)+名称:Boba Fett +电子邮件:[email protected]

#博客帖子[/ posts] ##检索所有帖子[get] +响应200(application / json)+属性(array [博客文章])

API蓝图是关于设计的第一哲学。类似于测试Intest驱动的开发,API BluePrint代表了API.Discussing您的API并在合同上建立合同之前,它倾向于更好的API设计。

一旦您的API蓝图到位,每个人都可以测试Aiglementation是否达到合同中规定的期望。

由于其广泛的采用,有一种针对API蓝图构建的过多的工具。从各种独立工具,如模拟服务器,文档和测试到全功能API生命周期解决方案。

要开始使用API​​蓝图,您需要一个纯文本编辑器。对于最值的编辑体验,将语法突出显示到术语到API蓝图(如果编辑器支持)。

一旦您编写了第一个API蓝图,您可以讨论朋友的API设计并使用API​​蓝图的工具。例如,要渲染文档,请生成您的服务模拟或开始测试Backend实施。