apidoc操作

约定不等于承诺〃 2022-05-23 12:21 134阅读 0赞

# apidoc操作 #

apidoc

--------------------

1.  首先要确认你的系统安装了nodejs
2.  install apidoc
    
    npm install -g apidoc
3.  init apidoc.json
    
        {
        "name": "测试apidoc",   
        "version": "1.0.0",                
        "description": "接口测试",
        "title": "test apidoc",
        "url" : "http://localhost/test",
        "sampleUrl" : "http://localhost/test"
        }
4.  init java ref:[http://apidocjs.com/\#params][http_apidocjs.com_params]  
    /\*\*
    
     *  @apiDefine CentraServerGroup Centra-Server  
        \*用户登录 注册 等  
        \*/

/\*\*  
\* @apiDefine UserParam  
\* @apiParam \{Number\} reqType .  
\* @apiParam \{String\} sign .  
\* @apiParam \{String\} password User password.  
\*/

/\*\*  
\* @api \{post\} /user/signin User sign in  
\* @apiName signIn  
\* @apiGroup CentraServerGroup  
\* @apiUse UserParam  
\* @apiParamExample \{json\} Request-Example:  
\{  
“osType”: 0,  
“password”: “99”,  
“userId”: “99@qq.com”  
\}

*  @apiSuccess \{String\} firstname Firstname of the User.
 *  @apiSuccess \{String\} lastname Lastname of the User.  
    \*
 *  @apiSuccessExample Success-Response:
 *  HTTP/1.1 200 OK
 *  \{
 *  “firstname”: “John”,
 *  “lastname”: “Doe”
 *  \}  
    \*
 *  @apiErrorExample Error-Response:  
    \{  
    “info”: \{  
    “message”: “Something went wrong with your Signin”  
    \},  
    “code”: 0  
    \}  
    \*/

**5. execute**  
apidoc -i src/ -o apidoc/

[demo____________:)))address:][1]

[http_apidocjs.com_params]: http://apidocjs.com/#params

发表评论取消回复

表情：

评论列表（有 0 条评论，134人围观）

还没有评论，来说两句吧...

相关阅读

相关 apiDoc 使用指南

安装 1. [安装node.js][node.js] 2. 安装apiDoc npm install apidoc -g 配置在你的项目根目录下新

短命女/ 2023年07月13日 12:17/ 0 赞/ 16 阅读

相关 apidoc 自动化生成 api接口文档

手写api接口太麻烦. 学习了apidoc自动生成接口文档,这边做一下整理要用组件那就必须先安装 apidoc,做一下全局安装 > npm install api

傷城~/ 2023年02月22日 12:14/ 0 赞/ 24 阅读

相关 webApi文档好帮手-apidoc使用教程

在开发后台接口的过程中，我们肯定要提供一份api接口文档给终端app。目前大多数的app的接口请求应该都是http+json的方式。但是一直苦于做不出份漂亮的api文档，

比眉伴天荒/ 2022年07月16日 15:18/ 0 赞/ 263 阅读

相关 APIDOC使用教程

安装 nodeJs Install \[nodeJs\] - https://nodejs.org/en/download/! \[NPM\] - In

待我称王封你为后i/ 2022年05月27日 13:28/ 0 赞/ 423 阅读

相关 apidoc操作

apidoc操作 apidoc -------------------- 1. 首先要确认你的系统安装了nodejs 2. install apidoc

约定不等于承诺〃/ 2022年05月23日 12:21/ 0 赞/ 135 阅读

相关【ApiDoc】官方文档(翻译)

> 本文主要参考[ApiDoc官方文档][ApiDoc] apidoc简介 apidoc是一款可以有源代码中的注释直接自动生成api接口文档的工具，它几乎支持目前主流的

不念不忘少年蓝@/ 2022年05月21日 10:06/ 0 赞/ 357 阅读

相关 Spring Boot（七）之apidoc生成

Spring Boot（七）之apidoc生成 1.安装apidoc 在安装apidoc之前需要安装node.js，下面介绍下Mac OS安装 1.1 安装nod

灰太狼/ 2022年05月16日 09:07/ 0 赞/ 244 阅读

相关 idea 自动生成apidoc

一、在工具栏中找到 tool >> Generate JAVADoc ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_sh

矫情吗；*/ 2022年04月24日 12:40/ 0 赞/ 515 阅读

相关 Apidoc生成Restful web Api文档

工具名称：apiDoc Git地址：[https://github.com/apidoc/apidoc][https_github.com_apidoc_apidoc]

小灰灰/ 2022年03月08日 06:28/ 0 赞/ 292 阅读

相关 linux apidoc 历史版本比较自定义模板

[http://blog.51yip.com/server/1880.html][http_blog.51yip.com_server_1880.html] [http_b

偏执的太偏执、/ 2022年02月28日 00:18/ 0 赞/ 196 阅读