SpringBoot非官方教程 | 第十二篇：springboot集成apidoc

xiaoxiaozi 发布于2019-08-15 12:15 / 3040人阅读

摘要：首先声明下，是基于注释来生成文档的，它不基于任何框架，而且支持大多数编程语言，为了系列的完整性，所以标了个题。二准备工作安装完安装它的项目源码。输命令输入目录输出目录是我的工程名。

首先声明下，apidoc是基于注释来生成文档的，它不基于任何框架，而且支持大多数编程语言，为了springboot系列的完整性，所以标了个题。

一、apidoc简介

apidoc通过在你代码的注释来生成api文档的。它对代码没有侵入性，只需要你写好相关的注释即可，并且它仅通过写简单的配置就可以生成高颜值的api接口页面。它基于node.js，所以你需要安装node.js环境。node.js安装，点击这里。这里就不介绍。

二、准备工作

安装完node.js安装api.doc,它的项目源码：https://github.com/apidoc/apidoc 。

通过命令安装：

npm install apidoc -g

三、注释怎么写

@api

@api {method} path [title]

method：请求方法，
path：请求路径 
title(可选)：标题

@apiDescription

@apiDescription text
text说明

@apiError

@apiError [(group)] [{type}] field [description]

（group）（可选）：参数将以这个名称分组，不设置的话，默认是Error 4xx 
{type}（可选）：返回值类型，例如：{Boolean}, {Number}, {String}, {Object}, {String[]} 
field：返回值字段名称 
descriptionoptional（可选）：返回值字段说明

@apiGroup

@apiGroup name
name：组名称，也是导航的标题

更多注释，参见官方文档：http://apidocjs.com/#params

四、写给栗子

首先写配置文件

在项目的主目录新建一个apidoc.json文件：

{
  "name": "example",
  "version": "0.1.0",
  "description": "A basic apiDoc example"
}

更多配置参考：http://apidocjs.com/#configur...

写个注释:

/**
 * @api {POST} /register 注册用户
 * @apiGroup Users
 * @apiVersion 0.0.1
 * @apiDescription 用于注册用户
 * @apiParam {String} account 用户账户名
 * @apiParam {String} password 密码
 * @apiParam {String} mobile 手机号
 * @apiParam {int} vip = 0  是否注册Vip身份 0 普通用户 1 Vip用户
 * @apiParam {String} [recommend] 邀请码
 * @apiParamExample {json} 请求样例：
 *                ?account=sodlinken&password=11223344&mobile=13739554137&vip=0&recommend=
 * @apiSuccess (200) {String} msg 信息
 * @apiSuccess (200) {int} code 0 代表无错误 1代表有错误
 * @apiSuccessExample {json} 返回样例:
 *                {"code":"0","msg":"注册成功"}
 */

用apidoc命令生成文档界面

先cd到工程的外层目录，并在外层目建个输出文档的目录，我建的是docapi。

输命令：

apidoc -i chapter4/ -o apidoc/

chapter4是我的工程名。

可以看到在apidoc目录生成了很多文件:

打开index.html,可以看到文档页面:

五、参考资料

apidoc

apidocjs.com

使用apidoc 生成Restful web Api文档

私有云服务器托管第十二篇 SpringBoot springboot webRTC Springboot介绍

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/67816.html

SpringBoot非官方教程 | 第二十二篇：创建含有多module的springboot工程

这篇文章主要介绍如何在springboot中如何创建含有多个module的工程，栗子中含有两个 module，一个作为libarary. 工程，另外一个是主工程，调用libary .其中libary jar有一个服务，main工程调用这个服务。创建根工程创建一个maven 工程,其pom文件为： 4.0.0 com.forezp springboot-multi-...

Scott 2019-08-16 12:38 评论0 收藏0
一起来学SpringBoot | 第十二篇：初探RabbitMQ消息队列

摘要：用于控制活动人数，将超过此一定阀值的订单直接丢弃。缓解短时间的高流量压垮应用。目前比较推荐的就是我们手动然后将消费错误的消息转移到其它的消息队列中，做补偿处理消费者该方案是默认的方式不太推荐。 SpringBoot 是为了简化 Spring 应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相...

Baoyuan 2019-08-16 12:35 评论0 收藏0
SpringBoot非官方教程 | 第十三篇：springboot集成spring cache

摘要：本文介绍如何在中使用默认的声明式缓存定义和接口用来统一不同的缓存技术。在使用集成的时候，我们需要注册实现的的。默认使用在我们不使用其他第三方缓存依赖的时候，自动采用作为缓存管理器。源码下载参考资料揭秘与实战二数据缓存篇快速入门本文介绍如何在springboot中使用默认的spring cache 声明式缓存 Spring 定义 CacheManager 和 Cache 接口用来统一不...

Magicer 2019-08-15 12:14 评论0 收藏0
SpringBoot非官方教程 | 第十一篇：SpringBoot集成swagger2，构建优雅的R

摘要：另外很容易构建风格的，简单优雅帅气，正如它的名字。配置一些基本的信息。三写生产文档的注解通过注解表明该接口会生成文档，包括接口名请求方法参数返回信息的等等。四参考资料中使用构建强大的文档 swagger,中文拽的意思。它是一个功能强大的api框架，它的集成非常简单，不仅提供了在线文档的查阅，而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api，简单优雅帅气...

荆兆峰 2019-08-16 10:44 评论0 收藏0