接口文档————Apidoc的使用

简介

APIdoc是一个接口文档，他跟Swagger的区别如下：

  • APIDOC可以离线查看，Swagger必须运行查看。
  • APIDOC生成文档复杂，Swagger生成文档很简单。

综上考虑，如果需要离线环境看文档的，还是推荐APIdoc，如果有条件线上查看的，十分推荐Swagger，因为它太省事啦！！

APIdoc长这样
在这里插入图片描述

下载APIdoc

首先你需要安装有node.js的环境（没有就下载个）
打开项目，在终端运行如下

npm intsall apidoc //安装apidoc

在根目录创建apidoc.json配置文件

在这里插入图片描述
apidoc.json内容如下

{
  "name": "闲置物品商城接口文档",
  "version": "0.0.1",
  "description": "闲置物品商城接口文档",
  "title": "闲置物品商城",
  "url": "http://127.0.0.1:8080",
  "sampleUrl": "http://127.0.0.1:8080"
}

使用

在需要生成接口文档的方法上写上注释，例子如下<