【Day 21】Google Apps Script - API Blueprint 篇 - API Blueprint 介绍

API Blueprint(蓝图)。一种用於 Web API 的强大的高级 API 描述语言。API 蓝图很简单，而且 API 生命周期中涉及的每个人都可以访问。它的语法简洁而富有表现力。借助 API Blueprint，您可以快速设计要创建的 API 和原型，或者记录和测试已部署的关键任务 API。-by apiblueprint.org。

今日要点：
》API Blueprint 介绍

API Blueprint 介绍

API Blueprint 是一种 RESTful API 描述语言，撰写容易快速，它采用 MSON，MSON 是 Markdown Syntax for Object Notation 的缩写，它是一种以人类可读的纯文本形式表示数据结构的方法。API Blueprint 在 2013 年开始发展，开放程序码采 MIT license，在 2017 年被 Oracle 收购，可以使用 Apiary 或 Aglio 来把 API Blueprint 视觉化。

API Blueprint 几个特色整理：

• 副档名：.apib
• Markdown：参加铁人赛的大家应该都对 Markdown 很熟了，API Blueprint 比较关注文件上，用的是以 Markdown 为基础再加上特别的语法，所以在首页上还强调 "high-level API 描述语言"。
• 开放程序码： MIT license，在 github 上有 8.3K 个星星
• Apiary：框架和工具服务网站，可以帮助设置模拟服务，也有免费的服务不过免费的 API 文件只能设定公开访问，在2017年 Oracle 收购了 Apiary。
• Aglio：具有主题支持的 API Blueprint 渲染器，可输出静态 HTML。

目前最活跃的有这种的 API 描述语言：

• API Blueprint (Markdown-like)
• RAML (YAML-like)
• OpenAPI Swagger (YAML-like)

以上是目前整理出的 API Blueprint 介绍，更多介绍可以参考以下的连结。
　

参考

• Overview of RESTful API Description Languages
• OpenAPI Specification
• A Short History of OAI and API Specifications
• API Blueprint
• help.apiary.io
• Github apiaryio/api-blueprint
• Github api-blueprint/examples/
• Swagger vs API Blueprint for API documentation
• API Blueprint: Markdown is awesome!
• 用 Aglio 做出漂亮的 API 文件