apidoc入门教程

前言

  在前后端分离项目的开发过程中，一份完整的API文档显得至关重要，今天给大家安利一款轻量级的、跨平台的、适用于大部分流行语言（包括但不限于Java、Python、javascript）的、适用于 RestFul风格的API文档生成工具—apidoc
个人认为超级好用😄

介绍

apidoc官网传送门：https://apidocjs.com/
  官网说明是：RESTful Web API 的内联文档，根据源代码中的 API 注释创建文档，使您能够将版本号附加到 API，以便您可以轻松跟踪版本之间的更改。

安装

  由于apidoc依赖于node环境，在安装之前需要保证系统已经安装好node和npm，再进行apidoc的安装任务。

 检查node环境

Nodejs官网传送门：https://nodejs.org/zh-cn/
  命令行输入：node -v

	node -v

 检查npm包管理工具

  命令行输入：npm -v

	npm  -v

 安装apidoc

  全局安装apidoc，命令行输入：npm install -g apidoc，如果Mac或Linux系统提示没有权限而安装失败，记得在命令前加sudo，如果下载速度很慢，可以全局配置npm的安装源为国内源如：淘宝(https://registry.npm.taobao.org),也可以在命令后面加上临时制定的源： --registry https://registry.npm.taobao.org