Swagger工具

利用Swagger工具可以快速进行API文档开发，并且用于前后台共享和测试。它是一组开源项目，主要包括：
Swagger-tools:提供各种与Swagger进行集成和交互的工具。例如模式检验、Swagger 1.2文档转换成Swagger 2.0文档等功能。
Swagger-core: 用于Java/Scala的的Swagger实现。与JAX-RS(Jersey、Resteasy、CXF…)、Servlets和Play框架进行集成。
Swagger-js: 用于JavaScript的Swagger实现。
Swagger-node-express: Swagger模块，用于node.js的Express web应用框架。
Swagger-editor：可让使用者在浏览器里以YAML格式编辑Swagger API规范并实时预览文档。可以生成有效的Swagger JSON描述，并用于所有Swagger工具（代码生成、文档等等）中。
Swagger-ui：一个无依赖的HTML、JS和CSS集合，可以为Swagger兼容API动态生成优雅文档。

可以使用editor做编辑，然后生成yaml或者json文件作为前后端分享，利用ui来展示。进一步地，可以通过在代码中内嵌一些标签自动生成API语义档案。
比如对于laravel，可以用这个项目
https://github.com/slampenny/Swaggervel

不过，个人感觉考虑到API的设计文档，不应是code得产物，而更应该是code得准则。并且先期的设计有很多需要更改，通常不建议开始就在内嵌代码自动生成的方案。