后端接口文档的编写

后端接口文档的编写：

1. 为什么我们前端也要了解后端接口文档的一个编写过程？

作为一名前端FE[front end]，前后端交互测试你必须懂。

是为了更好的前后端交互，工作流程的书写！

2. 接口文档编写方式很多 [常用]

• ShowDoc 【第三方平台】 https://www.showdoc.cc；公司的接口放在第三方平台，存放安全隐患

• 自行编写 => apidoc https://apidocjs.com/

  使用流程：

  1. 安装： npm install apidoc -g

  2. 使用：apidoc -i myapp/ -o apidoc/ -t mytemplate/

     -i  表示输入的目录
     -o  表示输出的目录
     -t  表示模板
     
     切记，名字根据自己项目的命名来书写。
     myapp        表示：输入/源目录名。项目文件的位置               apidoc -i myapp/
     apidoc       表示：输出目录名。放置生成的文档的位置		     apidoc -o apidoc/
     mytemplate   表示：使用模板输出文件。您可以创建和使用自己的模板。 apidoc -t mytemplate/