JAVA ssm b2b2c多用户商城系统源码（十二）springboot集成apidoc

首先声明下，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电子商务平台源码请加企鹅求求：一零叁八七七四六贰六

转载于:https://juejin.im/post/5c3869bce51d4543805e8cd5

JAVA ssm b2b2c多用户商城系统源码（十二）springboot集成apidoc相关推荐

JAVA ssm b2b2c多用户商城系统源码
最近公司要开发商城,让我多方咨询,最后看了很多,要不就是代码.表字段注释不全,要不就是bug多,要么就是文档缺少,最后决定自己开发一套商城. 下面是开发的一些心得体会,权且记录下来,给自己做个记录把. ...
JAVA springboot ssm b2b2c多用户商城系统源码-SSO单点登录之OAuth2.0登录流程(2)
上一篇是站在巨人的肩膀上去研究OAuth2.0,也是为了快速帮助大家认识OAuth2.0,闲话少说,我根据框架中OAuth2.0的使用总结,画了一个简单的流程图(根据用户名+密码实现OAuth2.0的 ...
JAVA springboot ssm b2b2c多用户商城系统源码（三）SpringBoot用JdbcTemplates访问Mysql
准备工作 jdk 1.8 maven 3.0 idea mysql 初始化mysql: -- create table `account` DROP TABLE `account` IF EXISTS ...
JAVA springboot ssm b2b2c多用户商城系统源码：服务消费（基础）...
使用LoadBalancerClient 在Spring Cloud Commons中提供了大量的与服务治理相关的抽象接口,包括DiscoveryClient.这里我们即将介绍的LoadBalance ...
(八)JAVA springcloud ssm b2b2c多用户商城系统源码：配置中心服务化和高可用
server端改造 1.添加依赖 <dependencies><dependency><groupId>org.springframework.cloud</ ...
JAVA springboot ssm b2b2c多用户商城系统源码(三)：服务提供与调用
上一篇文章我们介绍了eureka服务注册中心的搭建,这篇文章介绍一下如何使用eureka服务注册中心,搭建一个简单的服务端注册服务,客户端去调用服务使用的案例. 案例中有三个角色:服务注册中心.服务提 ...
JAVA b2b2c多用户商城系统源码-服务发现服务端EurekaServer微服务
一.大致介绍 1.众所周知,在现在互联网开发中,访问地址的IP和端口号是动态的,一个服务停掉再重新启用后IP和端口就可能发生了改变,所以用硬编码是肯定不行了.于是我们尝试使用新的技术来解决这一难题.需 ...
JooLun B2B2C多用户商城系统源码—多终端,无加密,不限域名,专业二开
Uniapp是目前商城开发前端技术中的热门,Uniapp的大火让开发者和企业都很兴奋,对于uniapp开发的商城源码,优点非常明显,就是开发成本低,uniapp商城源码编写一套源代码就能打包成小程序. ...
Java B2B2C多用户商城系统源码 B2B2C系统源码 APP小程序源码在线商城源码
语言:java 数据库:Mysql 移动端:小程序+APP 系统管理功能: 首页管理:首页配置.移动分类.专题配置.首页秒杀.首页拼团.首页试用.首页预售等. 为商城进行可视化编辑,以及更改商城主题色 ...

JAVA ssm b2b2c多用户商城系统源码（十二）springboot集成apidoc

一、apidoc简介

二、准备工作

三、注释怎么写

写个注释:

用apidoc命令生成文档界面

JAVA ssm b2b2c多用户商城系统源码（十二）springboot集成apidoc相关推荐

最新文章

热门文章

JAVA ssm b2b2c多用户商城系统源码 （十二）springboot集成apidoc

一、apidoc简介

二、准备工作

三、注释怎么写

写个注释:

用apidoc命令生成文档界面

JAVA ssm b2b2c多用户商城系统源码 （十二）springboot集成apidoc相关推荐

最新文章

热门文章

JAVA ssm b2b2c多用户商城系统源码（十二）springboot集成apidoc

JAVA ssm b2b2c多用户商城系统源码（十二）springboot集成apidoc相关推荐