精华内容
参与话题
问答
  • 2019独角兽企业重金招聘Python工程师标准>>> ...
    /**
     *
     *
     * @api {get} /data/new 1.01新增预算
     * @apiVersion 1.0.0
     * @apiGroup Data
     *
     * @apiDescription 新增预算
     *
     * @apiParam {Long} projectId 项目Id
     *
     * @apiSuccess {Number}   id            id
     *
     */
    
    /**
     * @apiDefine Data
     *
     * 用户组
     */
    

    通过apiDefine 实现

    转载于:https://my.oschina.net/cng1985/blog/857618

    展开全文
  • apidoc是通过js和json文件生成本地的html api文档,个人感觉相当好用;github地址:https://github.com/apidoc/apidoc1.安装 apidoc,如果不行安装一下nodejs npm install apidoc -g或者使用sudo npm install ...

    apidoc是通过js和json文件生成本地的html api文档,个人感觉相当好用;



    github地址:https://github.com/apidoc/apidoc

    1.安装 apidoc,如果不行安装一下nodejs 
    npm install apidoc -g

    或者使用

    sudo npm install apidoc -g

    2.cd 到当前目录,然后执行以下命令,会在本目录中创建api-docs的文件夹
    apidoc -i . -o api-docs


    需要创建两个文件,然后再在终端运行步骤2的命令:

    文件1,apidoc.json:

    {
      "title": "文档的标题",
      "name": "文档的名称",
      "version": "1.0.0",
      "description": "文档的说明内容",
      "url" : "https://github.com/apidoc/apidoc"
    }

    文件2,api.js:

    //-------------------------------------------------- api beans -----------------------------------------------//
    /**
     * @apiDefine LoginParam
     * @apiParam {String} username Your e-mail-address.
     * @apiParam {String} password Your password.
     */
    
    /**
     * @apiDefine UserParam
     * @apiParam {String} firstname Your firstname.
     * @apiParam {String} lastname  Your lastname.
     * @apiParam {Date}   birthday  Your birthday.
     */
    
    
    
    //-------------------------------------------------- api urls -----------------------------------------------//
    
    //----------------------- register ----------------------- //
    /**
     * @apiDefine RegisterGroup
     *
     * 注册相关接口
     */
    
    /**
     * @api {GET} /account/register Register a new user.
     *	
     * @apiGroup RegisterGroup
     * @apiName Register
     * @apiDescription 注册接口
     * @apiVersion 1.0.0
     * 
     * @apiUse LoginParam
     * @apiUse UserParam
     * @apiParam {Boolean} terms Checkbox to accept the terms.
     *
     * @apiSuccessExample Success-Response:
     *     HTTP/1.1 200 OK
     *     {
     *       "result": "success",
     *       "msg": "",
     *       userParam:
     *       	{
     *       		username:"用户",
     *       		password:"密码",
     *       	}
     *     }
     *
     * @apiErrorExample Error-Response:
     *     HTTP/1.1 200 OK
     *     {
     *       "result": "fail",
     *       "msg": "用户名或密码错误"
     *     }
     */
    
    //----------------------- login ----------------------- //
    /**
     * @apiDefine LoginGroup
     *
     * 登录相关接口
     */
    
    //------ login1.1.0版本 ------ //
     /**
     * @api {GET} /account/login Signin with an existing user.
     *
     * @apiGroup LoginGroup
     * @apiName login
     * @apiDescription 登录接口 2
     * @apiVersion 1.1.0
     *
     * @apiParam {LoginParam} LoginParam对象
     * @apiParam {Boolean} rememberme Checkbox to auto-login on revisit.
     */
    
    //------ login1.0.0版本 ------ //
    /**
     * @api {GET} /account/login Signin with an existing user.
     *
     * @apiGroup LoginGroup
     * @apiName login
     * @apiDescription 登录接口 1
     * @apiVersion 1.0.0
     *
     * @apiParam {LoginParam} LoginParam对象
     * @apiParam {Boolean} rememberme Checkbox to auto-login on revisit.
     */
    
    
    

    生成的效果图:




    展开全文
  • apidoc 生成api文档

    千次阅读 2015-06-18 15:26:05
    apidoc 是一个node.js 环境下根据代码注解生成api文档的小东西 所以首先下载node.js http://www.nodejs.org/ 我是win32环境所以下了个 下载好了打开node.js的命令界面 输入 npm install apidoc -g 等会就...

    apidoc 是一个node.js 环境下根据代码注解生成api文档的小东西

    所以首先下载node.js

    http://www.nodejs.org/

    我是win32环境所以下了个

    下载好了打开node.js的命令界面

    输入 npm install apidoc -g 等会就安装好了

    然后新建一个放置api的目录 如果你项目的注解写的符合规范的话也可以直接指定项目路径都行

    我是自己指定了一个就叫api

    准备一个json文件apidoc.json放到api目录下

    内容

    {
      "name": "zmn测试API",
      "version": "0.2.0",
      "description": "zmn测试系统API",
      "title": "zmn测试",
      "url" : "http://www.baidu.com",
      "sampleUrl" : "hhttp://www.baidu.com"
    }

    放入一个java类做测试

    
    public interface test {
    	/**
    	 * 
    	  * @api {post} /phonePayment.aspx zmn测试api
    	  * @apiPermission user
    	  * @apiDescription 接口描述 zmn测试接口
    	  * @apiGroup PAYMENT 我头上有犄角
    	  * @apiParam  {String} v   参数
    	  * @apiParam  {String} v1  参数1
    	  * @apiParam  {String} v2  参数2
    	  * @apiParam  {String} v3  参数3
    	  * @apiparam  {String} v4  参数4
    	  * @apiParam  {String} v5  参数5
    	  * @apiSampleRequest /phonePayment.aspx
    	  * @apiSuccess {String} r  	 返回值
    	  * @apiSuccess {String} r1  	 返回值1
    	  * @apiSuccess {String} r2  	 返回值2
    	  * @apiSuccess {String} r3  	 返回值3
    	  * @apiSuccess {String} r4  	 返回值4
    	  * @apiSuccess {String} r5  	 返回值5
    	  * @apiSuccessExample {json} Success-Response:
    	  *     HTTP/1.1 200 OK
    	  *     返回值格式   
    	  * @apiError  {String} MSG 	给用户(得)————这是哪个残废还写错字 提示
    	  * @apiErrorExample {json} Error-Response:
    	  *     HTTP/1.1 200 OK
    	  *    逻辑错误返回值格式
    	  * @apiVersion 0.2.0
    	  */
    	//其实这个方法可以没有  
    	public String test(String v,String v1,String v2,String v3,String v4,String v5);
    	
    
    }
    

    然后再敲一个命令

    i 源码位置 o 生成文件位置

    然后就生成文档了 大概就长这个样子很easy吧






    展开全文
  • apiDoc 生成api文档

    2020-01-08 12:19:30
    安装apiDoc npm install apidoc -g 配置 在你的项目根目录下新建apidoc.json文件,该文件描述了项目对外提供接口的概要信息如名称、版本、描述、文档打开时浏览器显示标题和接口缺省访问地址。apidoc.json ...

    安装

    1. 安装node.js
    2. 安装apiDoc

     

    npm install apidoc -g
    

    配置

    在你的项目根目录下新建apidoc.json文件,该文件描述了项目对外提供接口的概要信息如名称、版本、描述、文档打开时浏览器显示标题和接口缺省访问地址。
    apidoc.json

     

    {
      "name": "名称",
      "version": "版本",
      "description": "描述",
      "title": "标题",
      "url" : "根路径"
    }
    

    使用样例

     

    /**
     *
     * @apiDefine RkNotFoundException
     *
     * @apiError RkNotFoundException 描述
     *
     * @apiErrorExample Error-Response:
     *     HTTP/1.1 404 Not Found
     *     {
     *       "error": {
     *           "code": 404,
     *           "msg": "",
     *           "path" ""
     *       }
     *     }
     *
     */
    
    /**
     *
     * @api {get} /v3.1/ues/:sn/rt-info 描述
     * @apiVersion 3.1.0
     * @apiName GetUeRealTimeInfo
     * @apiGroup UE
     *
     * @apiHeader {String} Authorization 用户授权token
     * @apiHeader {String} firm 厂商编码
     * @apiHeaderExample {json} Header-Example:
     *     {
     *       "Authorization": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjM2NzgsImF1ZGllbmNlIjoid2ViIiwib3BlbkFJZCI6MTM2NywiY3JlYXRlZCI6MTUzMzg3OTM2ODA0Nywicm9sZXMiOiJVU0VSIiwiZXhwIjoxNTM0NDg0MTY4fQ.Gl5L-NpuwhjuPXFuhPax8ak5c64skjDTCBC64N_QdKQ2VT-zZeceuzXB9TqaYJuhkwNYEhrV3pUx1zhMWG7Org",
     *       "firm": "cnE="
     *     }
     *
     * @apiParam {String} sn 设备序列号
     *
     * @apiSuccess {String} sn 设备序列号
     * @apiSuccess {Number} status 设备状态
     * @apiSuccess {Number} soc 电池电量百分比
     * @apiSuccess {Number} voltage 电池电压
     * @apiSuccess {Number} current 电池电流
     * @apiSuccess {Number} temperature 电池温度
     * @apiSuccess {String} reportTime 上报时间(yyyy-MM-dd HH:mm:ss)
     *
     * @apiSuccessExample Success-Response:
     *     HTTP/1.1 200 OK
     *     {
     *       "sn": "P000000000",
     *       "status": 0,
     *       "soc": 80,
     *       "voltage": 60.0,
     *       "current": 10.0,
     *       "temperature": null,
     *       "reportTime": "2018-08-13 18:11:00"
     *     }
     *
     * @apiUse RkNotFoundException
     *
     */
    @RequestMapping(value = "/{sn}/rt-info", method = RequestMethod.GET)
    public UeRealTimeInfo getUeRealTimeInfo(@RequestHeader(Constants.HEADER_LOGIN_USER_KEY) long userId, @PathVariable("sn") String sn) {
    
        return ueService.getRealTimeInfo(sn);
    }
    

    @api

     

    @api {method} path [title]
    

    HTTP接口调用方法、路径及名称

    @apiVersion

     

    @apiVersion version
    

    api 版本号

    @apiName

     

    @apiName name
    

    api 名称

    @apiGroup

     

    @apiGroup name
    

    api 分组

    @apiHeader

     

    @apiHeader [(group)] [{type}] [field=defaultValue] [description]
    

    请求头参数

    @apiParam

     

    @apiParam [(group)] [{type}] [field=defaultValue] [description]
    

    请求参数

    @apiSuccess

     

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

    返回数据描述

    @apiSuccessExample

     

    @apiSuccessExample [{type}] [title]
                       example
    

    接口成功返回样例

    @apiError

     

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

    接口失败描述

    @apiErrorExample

     

    @apiErrorExample [{type}] [title]
                     example
    

    接口失败返回样例

    @apiDefine

     

    @apiDefine name [title]
                         [description]
    

    类似于宏定义,可以被引用

    @apiUse

     

    @apiUse name
    

    使用@apiDefine定义的描述

    更详细的说明请参考官方文档http://apidocjs.com

    生成文档

    cd到apidoc.json所在路径(即项目根目录)执行如下命令即可

     

    apidoc -i src/ -o apidoc/

    apidocjs官方网站 https://apidocjs.com

    展开全文
  • API、接口、协议、API端点

    千次阅读 多人点赞 2018-09-25 10:17:38
    1.API定义: 1)API 是用于构建应用程序软件的一组子程序定义,协议和工具。一套明确定义的各种软件组件之间的通信方法,实现和其他软件快速交互。 2)API 应用范围很广:从操作系统中简单的 fork() 到我们接触的...
  • 使用apidoc生成api文档

    千次阅读 2019-03-19 16:01:53
    apidoc根据其自定义注释语法自动生成api文档,我们只需要把代码中的注释按照其语法来写就能生成需要的文档,不需要手动写markdown。 apidoc生成的文档相比markdown,漂亮直观又实用。 如果API需要修改或者更新,直接...
  • 通过apidoc生成api文档

    2015-09-16 16:43:00
    2019独角兽企业重金招聘Python工程师标准>>> ...
  • apiDoc 详解 api接口文档生成

    万次阅读 2019-02-20 14:11:50
    PHP使用apiDoc api接口文档安装apidocapidoc 命令参数列表配置(apidoc.json)apidoc.json配置项apidoc注释参数@api@apiErrorExample@apiDefine@apiDeprecated@apiDescription@apiError@apiExample@apiGroup@apiParam@...
  • 使用apidoc 生成Api接口文档

    千次阅读 2018-06-17 14:28:17
    前言: ...apidoc是一个轻量级的在线接口文档生成系统,仅需要按照要求书写相关注释,就可以生成可读性好、界面美观的在线接口文档 一、apidoc的基本概念 apoDoc是从源码的注释中生成RestFul...
  • 现在越来越流行前后端分离,使得前后端解耦。前后端的联系来源于数据接口,所以...但是swagger对于windows版本NodeJS开发者有点不友好,所以我尝试了一下最后放弃了,最后选择了使用apidoc来自动化生成API文档。 wh...
  • 首发于fxm5547的博客 详细阅读apiDoc官方文档 ... 项目中apiDoc文件结构 整体结构 ...apidoc.json ...公共部分定义-状态码分组(apiSuccess、apiError) 定义 使用 公共部分定义-错误响应(ap...
  • apidoc @apiGroup兼容中文

    2018-05-18 15:47:00
    C:\Users\ZhiJiao361\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js 2.注释代码 //group = group.replace(/[^\w]/g, '_'); 转载于:ht...
  • 什么是apidoc apidoc是一个轻量级的在线REST接口文档生成系统,支持多种主流语言,包括Java、C、C#、PHP和Javascript等。使用者按照要求书写相关注释,就可以生成可读性好、界面美观的在线接口文档。 这里了解更多 ...
  • 安装apidoc 配置(apidoc.json) apidoc.json配置项 apidoc注释参数 @api @apiErrorExample @apiDefine @apiDeprecated @apiDescription @apiError @apiExample @apiGroup @apiParam @...
  • 使用apidoc 生成Restful web Api文档

    万次阅读 热门讨论 2016-01-06 17:29:10
    在项目开发过程中,总会牵扯到接口文档的设计与编写,之前使用的都是office工具,写一个文档,总也是不够漂亮和直观。...工具名称:apiDoc Git地址:https://github.com/apidoc/apidoc 项目地址:http://apidocjs
  • Spring项目集成apidoc生成api接口文档

    万次阅读 2018-01-29 14:05:24
     JavaWeb/spring项目写成的api接口,需要自动生成api文档,甚至需要在线测试接口。考虑实现的方案有swagger,apidoc,spring rest docs。在之后的项目都有一一尝试,最终还是觉得apidoc的方式比较合适,虽然有一些...
  • TensorFlow报错:AttributeError: module ‘tensorflow._api.v1.train’ has no attribute 'SummaryWriter’等 分析:版本更新,方法调用方式改变 解决方式: 报错 原方法 更改后方法 ...
  • Api-apidoc.zip

    2019-09-18 09:41:35
    Api-apidoc.zip,REST API API,Suto GO,Java,SWIFT,JavaScript,RIST,PHP,Python和Ruby,一个api可以被认为是多个软件设备之间通信的指导手册。例如,api可用于web应用程序之间的数据库通信。通过提取实现并将...
  • ApiDoc 自动生成API文档

    千次阅读 2017-12-15 13:56:41
    1、确认已经安装node.js,可以使用npm命令 否则要先安装node 2、安装apidoc 命令行运行 npm install apidoc -g 3、在项目的当前目录下编写一个脚本genAPIdoc....(将生成的API文档 -o 输出output到上层文件夹的doc/

空空如也

1 2 3 4 5 ... 20
收藏数 881,333
精华内容 352,533
关键字:

apidoc