用户注册



邮箱:

密码:

用户登录


邮箱:

密码:
记住登录一个月忘记密码?

发表随想


还能输入:200字

cloud云    -  云代码空间

——

(十二)java springcloud b2b2c多用户商城系统-springboot集成apid

2019-01-30|143阅||

摘要:(十二)java springcloud 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电子商务平台源码请加企鹅求求:817983997

顶 0踩 0收藏
分享到:
更多
文章评论
    发表评论

    个人资料

    • 昵称: cloud云
    • 等级: 高级设计师
    • 积分: 5150
    • 代码: 0 个
    • 文章: 216 篇
    • 随想: 0 条
    • 访问: 10 次
    • 关注

    人气代码

      标签

      java(57)api(3)教程(27)Spring(60)cache(2)+(8)springmvc(3)mybatis(4)(十)(2)(十一)(2)Cloud(29)Cloud-hong(1)Cloud分布式微服(1)Cloud-Hong(1)Cloud分布式微服(1)Cloud-鸿鹄Cl(1)Cloud--Hon(1)Cloud分布式微服(1)Cloud--Hon(1)Cloud分布式微服(1)Cloud--hon(1)Cloud分布式微服(1)Cloud--Hon(1)分布式微服务云系统-(1)企业分布式微服务云架(1)Cloud-Hong(1)Cloud分布式微服(1)Boot(4)企业分布式微服务云架(1)Cloud--hon(1)Cloud分布式微服(1)Cloud--Hon(1)分布式微服务云系统-(1)Cloud--Hon(1)Cloud分布式微服(1)企业分布式微服务云架(1)Cloud--hon(1)Cloud分布式微服(1)Cloud--Hon(1)分布式微服务云系统-(1)cloud--鸿鹄C(1)源码(12)-(22)cloud集成项目(1)Cloud云服务(1)整合spring(12)cloud云服务架构(5)介绍一下Spring(1)Cloud微服务架构(1)总结Spring(1)Cloud云架构(14)登出流程(3)(2)Cloud+Spri(1)Boot+Mybat(1)+微服务(1)企业分布式微服务云架(1)Spring+(1)SSO单点登录应用认(1)跟大家介绍一下关于S(1)Consul(1)Cloud构建微服务(1)Cloud构建微服务(1)Cloud构建微服务(1)SSO单点登录之OA(1)根据token获取用(1)Netflix(3)springclou(1)RestTempla(1)HongHu云架构c(1)Commons(1)普通抽象(1)Config-Git(1)Cloud--Hon(1)分布式微服务云系统-(1)Cloud微服务分布(1)企业分布式微服务云架(1)Cloud自定义引导(1)SSO单点登录之OA(1)SSO单点登录之OA(1)SSO单点登录之OA(1)cloud云架构-S(1)企业分布式微服务云架(1)企业分布式微服务云架(1)Cloud--Hon(1)Cloud分布式微服(1)项目过程构建(1)分享Spring(1)Config服务器(1)Cloud微服务架构(1)Cloud微服务分布(1)Cloud-hong(1)Cloud分布式微服(1)springclou(1)Cloud微服务分布(1)SpringBoot(59)Cloud各个组件配(1)RestTempla(1)Cloud分布式微服(1)Cloud自定义引导(1)Cloud构建微服务(1)Cloud构建微服务(1)(十七)(1)-消息驱动(1)(十六)(1)-使用spring(1)企业级(29)(二)(3)cloud项目(1)(十二)(2)(九)整合sprin(1)commonserv(1)SSO单点登录之OA(1)SSO单点登录之OA(1)SSO单点登录之OA(1)(九)整合sprin(1)commonserv(1)SSO单点登录之OA(1)SSO单点登录之OA(1)SSO单点登录之OA(1)(十三)(1)SSO单点登录之OA(1)B2B2C(53)(九)Java(1)o2o多用户商城(24)(十)Java(1)(十一)Java(2)(十二)(1)springclou(1)springclou(1)springclou(1)SSO单点登录之OA(1)springclou(1)SSO单点登录之OA(1)springclou(1)(十三)java(2)b2b2c多用户商城(7)(十四)Java(1)(十五)Java(2)(十六)Java(2)b2b2c多用户商城(1)SSO单点登录之OA(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)(十七)Java(1)springclou(1)springclou(1)项目构建过程(七)(2)mybatis电子商(1)Springclou(1)Cloud构建分布式(1)SpringClou(1)Config)(1)ssm(15)springclou(1)b2b2c多用户商城(1)B2B2C多租户电子(1)springclou(1)springclou(1)springclou(1)springclou(1)企业级java(5)shop(6)多用户商城系统源码(2)(十二)java(1)关于SpringCl(1)Bus)(1)b2bc商城系统开源(1)Sleuth)(1)多用户商城系统源码-(1)微服务java_b2(1)springclou(1)springclou(1)springclou(1)springclou(1)b2bc商城系统开源(1)配置自动刷新(1)(四):(1)b2b2c多用户商城(1)Dashboard和(1)b2b2c多用户商城(1)b2b2c多用户商城(1)多用户商城系统(1)(十)用spring(2)springboot(1)(十三)spring(1)微服务java_b2(1)(十二)spring(1)mybatis多租户(1)多级分销spring(1)mybatis多租户(1)多级分销spring(1)mybatis多租户(1)b2b2c多用户商城(1)(二)Spring(3)Boot配置文件详解(1)springclou(1)(一)构建第一个Sp(1)多用户商城系统(三)(1)微服务java_b2(1)整合JPA(1)springclou(1)多级分销Spring(1)多级分销spring(1)mybatis多租户(1)多级分销spring(1)mybatis多租户(1)mybatis多租户(1)多级分销Spring(1)cloud微服务分布(1)Cloud集成项目简(1)cloud微服务分布(1)整合企业架构的技术点(1)(一)spring(1)(十三)java(1)(五)JAVA(1)多用户商城系统源码:(1)b2b2c多用户商城(1)springclou(1)(十二)Spring(1)多用户商城系统:使用(1)Sleuth和Zip(1)(十)java(2)多用户商城系统源码:(1)(十一)企业级jav(1)b2bc商城系统开源(1)(八)java(1)(九)Java(1)多级分销spring(1)mybatis多租户(1)springclou(1)springclou(1)b2b2c多用户商城(1)(十二)微服务多用户(1)springclou(1)Springclou(1)分布式环境下自动发现(1)springclou(1)springclou(1)b2b2c多用户商城(1)b2bc商城系统开源(1)多级分销Spring(1)Dashboard和(1)多级分销Spring(1)多级分销spring(1)mybatis多租户(1)springclou(1)(十一)Java(1)springclou(1)b2bc商城系统开源(1)springclou(1)b2b2c多用户商城(1)多用户商城系统源码((1)springboot(1)Java多用户商城系(1)多用户商城系统(一)(1)springclou(1)Springboot(1)springclou(1)b2b2c多用户商城(1)b2b2c多用户商城(1)springboot(1)(十四)(1)多级Springbo(1)Springboot(1)b2b2c多用户商城(1)springclou(1)springclou(1)springclou(1)springclou(1)common-ser(1)b2b2c多用户商城(1)b2b2c多用户商城(1)企业云架构commo(1)b2bc商城系统开源(1)common-ser(1)微服务java_b2(1)多租户电子商城系统(1)b2b2c多用户商城(1)多级分销Spring(1)整合企业架构的技术点(1)springboot(1)企业云架构commo(1)微服务架构(2)(七)springb(1)(八)springb(1)(九)springb(1)Restdocs创建(1)(十一)spring(1)(十二)spring(1)(十四)在sprin(1)(十五)Spring(1)(十六)用restT(1)(十六)用restT(1)cloud微服务分布(1)SpringClou(1)服务的注册与发现(E(1)SpringClou(1)服务消费者(rest(1)SpringClou(1)服务消费者(rest(1)SpringClou(1)关于SpringCl(1)springclou(1)Cloud微服务架构(1)(六)Spring(1)Cloud云架构一服(1)(三)Spring(1)Cloud云架构一定(1)互联网分布式微服务云(1)(十六)用restT(1)教程(十五)Spri(1)(十四)在sprin(1)Config-Git(1)springclou(1)commonserv(1)commonserv(1)SSO单点登录之OA(1)Cloud云架构-S(1)根据token获取用(1)SpringClou(1)SpringClou(1)企业分布式微服务云S(1)(四)断路器(Hys(1)企业分布式微服务云S(1)(五)路由网关(zu(1)企业分布式微服务云S(1)(六)分布式配置中心(1)企业分布式微服务云S(1)(七)高可用的分布式(1)SpringClou(1)服务消费者(rest(1)(十七)上传文件(1)Tasks)(1)(七)springb(1)(八)springb(1)(九)springb(1)Restdocs创建(1)(十一)spring(1)(十二)spring(1)(十三)spring(1)(十四)在sprin(1)(十五)Spring(1)(十六)用restT(1)(十八)定时任务(S(1)

      最新提问

        站长推荐