摘要:
前后端分离的工作模式于今是非常流行了,前后端工作的对接,就离开不了API文档的辅助。
根据自己以往的工作经历,以及了解的一些资讯,API文档的建立,无非以下几种方式:
1. word文档模板
2. 第三方平台,类如postman、showdoc等
3. 框架内单独自定义一套绑定路由的结构,再解析成html页面
4. 在框架内每个路由的方法的注释块里按照规则写注释,再解析生成api文档
5. 框架内直接编辑markdown文件,再转换成html页面 阅读全文