可能在很多地方，编写文档或许是非常敷衍或潦草的事情，一个可能连排版都没有的 Word 文档可能就充当了文档的重要地位，但是这对于开发协作和后期的未知问题，仅仅只是时间的问题。在开发 RESTful API 中，随着时间的增长，API 的数量越来越多，查阅维护整理也就变得更加需要，文档需求的地位就越来越高。而编写 RESTful API 文档的方式有很多，例如：RAML、Swagger、apiDoc... 而我选择的是 API Blueprint，为啥呢？因为是用 Markdown 来进行编写，而且能够利用一些工具通过语法渲染成文档网页，何乐而不为呢？ I. 语法 之前我们讲了，API Blueprint 虽然是以 Markdown 为基础语法，但后缀名规范保存为 .apib 而不是 .md ，想入坑也是要记住一些 API Blueprint 规范的指定语法的，语法方面我认为只需要讲比较重要的要点而不需要详细来讲，