Linux系统安装、使用apidoc教程

apidoc安装教程：

1、首先要确定是否已经安装了node.js，如果未安装可以参考node.js的安装教程：https://blog.csdn.net/ba_qi/article/details/103177812

2、apidoc可以利用npm来快速安装，输入命令 npm install apidoc -g 进行apidoc的安装，如下图：

下图为安装完毕：

3、输入apidoc -v 命令，如果出现如下图所示的界面，则表示apidoc已安装成功

apidoc 使用：

apidoc 一些重要的参数如下表所示：

参数	描述
-f	选择要解析的文件，支持正则表达式。-f参数可以使用多次，多个表达式可以对应不同的-f。如：apidoc -f ".\.js$" -f ".\\.ts$"
-i	选择源代码所在的位置。如：apidoc -i myapp/
-o	选择生成的目标文件所在的位置。如：apidoc -o apidoc/
-t	为生成文件选择模板，可以创建和使用自定义的模板。（笔者注：目前为止，笔者还没有使用过这个参数）
-h	跟绝大多数命令一样，这个参数可以打印出帮助文档

1	apidoc -i src/ -o apidoc/ # 可以通过搜索src目录中的文件快速的生成文档文件，并将这些文件放在apidoc目录下。

1	apidoc -h # 显示帮助信息

使用apidoc

一个典型的文件目录结果如下图所示。

其中：

apidoc.json：apidoc的项目级配置文件，它必须位于整个工程目录顶层。

Demo1.java：用于演示的demo源文件，它可以位于整个工程目录的顶层目录及其子目录下。apidoc会搜索整个工程目录选择所有可能的源文件。

apidoc.json和Demo1.java中包含的代码分别如下：

{

"name": "demo",

"version": "1.0.0",

"description": "这是一个简单的apidoc的demo",

"title": "demo",

"url" : "https://api.github.com/v1"

}

/**

* @api {get} /user/:id Request User information

* @apiName GetUser

* @apiGroup User

* @apiParam {Number} id Users unique ID.

* @apiSuccess {String} firstname Firstname of the User.

* @apiSuccess {String} lastname Lastname of the User.

Shell中输入apidoc -i ./ -o ../../public/doc命令，如果出现如下图所示的Done结果，则表明文档已经生成，位于同级目录的apidoc（与-o ../../public/doc对应）目录下

打开../../public/doc目录，可以看到如下图所示的静态Web文件。

浏览器中访问index.html就可以看到生成在线接口文档网站

配置

apidoc.json文件是项目级的配置文件，接下来简单地介绍一下其中常用的配置项。

配置名	描述
name	工程名。如果该字段不存在，则apidoc会尝试通过package.json（apidoc顶层配置文件）来生成
version	工程文档的版本号。如果该字段不存在，则apidoc会尝试通过package.json（apidoc顶层配置文件）来生成
description	工程详细描述。如果该字段不存在，则apidoc会尝试通过package.json（apidoc顶层配置文件）来生成
title	文档标题，显示在文档界面的最上方
url	整个api url的前缀，接下来的所有接口url都会加上这个前缀
sampleUrl	api示例的url前缀。如果设置了这个值，则界面中显示请求表单，可以用于测试接口
header
title	文档头（header）的连接锚点名
filename	文档头所使用的文件
footer
title	文档尾（footer）的连接锚点名
filename	文档尾所使用的文件
order	接口的排列顺序list，如果不指定，则由apidoc自行确定

一个比较完整的配置文件如下：

{"name": "demo","version": "1.0.0","description": "这是一个简单的apidoc的demo","title": "api接口demo","url": "https://api.github.com/v1","sampleUrl": "https://api.github.com/v1/test","header": {"title": "接口文档","filename": "header.md"},"footer": {"title": "footer","filename": "footer.md"},"order": ["Error","Define","PostTitleAndError","PostError"]}

更多的配置项请参考apidoc官方文档站点。

Linux系统安装、使用apidoc教程相关推荐

linux系统安装u盘教程deepin,带你了解国产操作系统“深度（deepin）”之制作U盘启动教程...
原标题:带你了解国产操作系统"深度(deepin)"之制作U盘启动教程最近也是由于中美贸易关系,国产操作系统一度成为热门话题,在UOS还没正式投入使用以前,我先带大家讲讲我们国产 ...
linux系统安装mysql详细教程
一安装前准备 1.检查是否已经安装过mysql,执行命令 [root@localhost /]# rpm -qa | grep mysql 从执行结果,可以看出我们已经安装了mysql-libs-5 ...
linux系统安装mysql8(详细教程)
作者:ChenZhen 博客地址:https://www.chenzhen.space/ 版权:本文为博主 ChenZhen 的原创文章,本文版权归作者所有,转载请附上原文出处链接及本声明. ...
linux环境重装rabbitmq,Linux系统安装RabbitMQ详细教程-Go语言中文社区
1.安装Erlang 安装类库 yum -y install ncurses-devel yum -y install openssl-devel yum -y install unixODBC-de ...
linux系统安装jdk8详细教程
文章目录前言一.下载jdk8的安装包二.压缩包上传解压 1.将下载好的压缩包使用ftp工具上传到服务器 2.将压缩包解压到指定目录三.配置jdk的环境变量四.测试是否安装成功前言虚拟机版 ...
linux系统安装hass.io教程,威联通NAS虚拟机ubuntu安装homeassistant之hass.io指南
hass.io是homeassistant的docker版本,方便安装使用,对小白用户来说相对简单易用.下面我就给大家介绍怎么在威联通NAS的虚拟机里安装hass.io. 安装ubuntu16.04s ...
Linux系统安装Java和mysql并关联DBeaver,上传Springboot jar包,数据库如何防止黑客攻击
Linux系统安装Java 安装版本jdk-8u171-linux-x64.tar.gz1,上传到linux的 root目录下 2,tar -zxvf jdk-8u171-linux-x64.tar. ...
【Ubuntu】Linux系统安装python3.6
目录一.前言二.安装过程 1.打开终端并检测python环境 2.下载安装包 3.导入公钥 4.更新 5.安装 6.调整优先级 7.测试结果一.前言因为要用到在ubuntu系统中使用pytho ...
大白菜linux系统安装步骤,GRUB简单入门教程
一.什么是多重操作系统引导管理器,什么是GRUB: 1.什么是多重操作系统引导管理器及工作原理: 系统启动引导管理器,是在计算机启动后运行的第一个程序,他是用来负责加载.传输控制到操作系统的内核,一旦 ...
linux操作系统安装自定义分区,CentOS linux操作系统安装图文教程
目前linux操作系统安装方法非常多,我们可以通过一些常用的U盘启动盘工具制作对应的启动 U 盘后,然后再进行安装 Linux 系统即可.以下是今天给大家分享的 CentOS linux操作系统安装图 ...

Linux系统安装、使用apidoc教程

Linux系统安装、使用apidoc教程相关推荐

最新文章

热门文章