码迷,mamicode.com
首页 > 编程语言 > 详细

SpringCloud微服务云架构构建B2B2C电子商务平台(十二)springboot集成apidoc

时间:2019-01-09 12:14:43      阅读:208      评论:0      收藏:0      [点我收藏+]

标签:com   没有   lin   pat   code   json   api   object   end   

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

一、apidoc简介

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

二、准备工作

安装完node.js安装api.doc

通过命令安装:

npm install apidoc -g

三、注释怎么写

技术分享图片
@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:组名称,也是导航的标题
技术分享图片

写个注释:

技术分享图片
 /**
     * @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/-i 输入目录 -o 输出目录

 资料和源码来源地址

Spring Cloud大型企业分布式微服务云构建的B2B2C电子商务平台源码请加企鹅求求: 一零叁八七七四六贰六 

SpringCloud微服务云架构构建B2B2C电子商务平台(十二)springboot集成apidoc

标签:com   没有   lin   pat   code   json   api   object   end   

原文地址:https://www.cnblogs.com/itspring/p/10243440.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!