精华内容
下载资源
问答
  • java接口文档规范

    2017-06-01 10:55:27
    文档为md格式
  • 接口文档规范

    2021-01-03 23:38:24
    什么是接口 接口全称是应用程序编程接口,是应用程序重要的组成部分。接口可以是一个功能,例如天气查询,短信...接口文档规范 接口文档内容可大致分为请求前、请求后内容。 请求前的内容包括接口的基本信息。内容如下

    什么是接口

    接口全称是应用程序编程接口,是应用程序重要的组成部分。接口可以是一个功能,例如天气查询,短信群发等,接口也可以是一个模块,例如登录验证。接口通过发送请求参数至接口url,经过后台代码处理后,返回所需的结果。

    为什么需要编写接口文档

    由于接口所包含的内容比较细,在项目中常常需要使用接口文档。研发人员可以根据接口文档进行开发、协作,测试人员可以根据接口文档进行测试,系统也需要参照接口文档进行维护等。

    接口文档规范

    接口文档内容可大致分为请求前、请求后内容。 请求前的内容包括接口的基本信息。内容如下: 1、接口协议。如http、https、tcp协议等。 2、接口请求方式。常见的请求方式有get、post,还有put、delete等。 3、接口url。接口请求的url 4、接口名称。用于识别接口。 5、接口请求头部。包含请求头部参数、参数说明。 6、接口请求体。包含请求参数、参数说明,与参数格式。 7、

    请求后的内容包括接口响应后的结果。内容如下: 1、响应结果。包括返回头部、返回结果参数,参数值说明,参数类型。 2、示例。成功示例与失败示例,与对应的状态码,例如成功返回状态码200。 3、

    以上是接口文档必要的基本信息,在项目中为了方便问题追溯与后期维护,接口文档还需要记录接口状态、版本、负责人、创建人、最后编辑人、时间、接口说明等信息。最终一份完善的api文档如下所示。

    接口文档编写需要花费一定的精力,随着项目不断更新,接口文档也逐渐成为项目的核心文件。写好接口文档是应用程序发展的基础。 演示工具为Eolinker,使用地址:www.eolinker.com

    展开全文
  • 支付宝接口文档规范

    2018-10-21 13:23:33
    文档适用于所有接入支付宝开放平台的第三方应用、服务窗。
  • 移动开发接口文档规范

    热门讨论 2013-11-25 11:02:57
    移动互联网开发接口文档规范,只有规范接口文档,才能保证服务器和客户端双方的同时开发而又互不影响,也能保证最终的顺利对接
  • 接口文档规范的重要性

    千次阅读 2019-09-03 11:30:36
    接口文档规范的重要性

    接口文档规范的重要性

    展开全文
  • java开发中定义接口文档,可以作为定义接口规范的一个参考。具有一定的参考价值。方便前后端分离的项目中的交流
  • 后台接口文档规范

    千次阅读 2019-05-30 17:43:57
    后台接口文档规范---便于后期查看,记录一下,如有不妥,请联系修改,谢谢 后台接口文档规范整理 项目名称一 通用设置 版本号【1.1】 环境域名地址: -Dev: -Test: -Pre: -Pro:...

    后台接口文档规范---便于后期查看,记录一下,如有不妥,请联系修改,谢谢

    • 后台接口文档规范整理
      • 项目名称一
        • 通用设置
          • 版本号【1.1】
          • 环境域名地址:
            • -Dev:
            • -Test: 
            • -Pre:
            • -Pro:
          • API地址前缀:【如有, 例如:/api/ 】
        • 模块名称一【对照原型一二级菜单目录】
          • 【新增/修改/删除】接口名称1
            • 负责人:
            • 简要描述:(如修改可以说明一下)
            • 请求URL:
            • 请求方式:POST/GET/PUT
            • 请求类型:【application/json】
            • 参数:【参数名称、类型、是否必须、示例、说明】
            • 请求参数示例:{}
            • 返回示例:{code:0, msg: "", data:{}}
            • 返回参数说明:
            • 错误代码说明:【错误代码、说明】
          • 【新增/修改/删除】接口名称2
        • 模块名称二
          • 【新增/修改/删除】接口名称1
          • ...

     

    如下图所示:

    接口示例

     

     

     

     

     

     

    展开全文
  • 接口文档一般是五个大的部分。下面我会一一列出 1.一般来说 (第一页) 首先的是 XXXXX接口规格 修订历史记录 日期 版本 说明 作者 2019-03-26...

    接口文档一般是五个大的部分。下面我会一一列出

    1.一般来说 (第一页)

    首先的是

    XXXXX接口规格

     

                                   修订历史记录

    日期

    版本

    说明

    作者

    2019-03-26

    V0.1

    xxxxxxx初稿

    QQQ

    2019-03-26

    V0.2

    1.xxxx

    2.xxxx

    3.xxx

    QQQ

    2019-03-27

    V0.3

    1.xxxx

    2.xxxx

    3.xxx

    QQQ
    2019-03-27

    V0.4

    1.xxxx

    2.xxxx

    3.xxx

    QQQ

     

     

     

     

     

    注意所有的更新的记录中说明都要写完整

    2. 第二部分 (一般都是目录)

    3. 第三部分

    1. 说明
    2. 技术规格 - 调用协议
    3. 通用规范 - 请求头和签名
    4. 签名 - 数据加密 和 响应码处理建议

     4.第四部分 接口 

    (1)肯定是要写的

    baseurl

    /xxxx/xxxx

    (2)具体的接口规范

    首先看格式

    1.XXXXX ------ 这是标题(一般都是啥创建啊,修改啊,查询啥的列表啊)

    • 基本信息

    接口描述

    XXXXX(和上面标题一样的)

    URL

    {baseurl}/xxxxx/xxxxxx

    报文格式

    JSON

    请求方式

    POST

    • 调用参数

    #

    参数名

    数据类型

    必须

    长度

    说明

    备注

    1

    id

    String

    N

    32

    id

     

    2

    name

    String

    Y

    64

    名称

     

    3

    status

    int

    Y

    3

    使用状态

     

    4

    type

    int

    Y

    3

    种类

     

    调用样例
    http://localhost:8080/xxx/xxxx/xxxx

    body

    {

    "id":"string",

    "name":"string",

    "no":"string",

    "type":0

    }

    • 返回数据

    #

    参数名

    数据类型

    必须

    长度

    说明

    备注

    1.  
    resultCode
    String

    Y

     

    状态码

    00000表示成功

    2.

    msg
    String

    Y

     

    返回的消息内容

     

    3.

    result
    Json

    N

     

    返回内容

     

    • 返回样例

    成功:

    {

    "resultCode":"00000",

    "msg":"Success.",

    "result":null

    }

    失败:

    {

    "resultCode":"XXXXX",

    "msg":"XXXXXX",

    "result":null

    }

    5.第五部分,错误码对照

    附件:错误码对照表

    #

    错误编码

    说明

    备注

    1

    10001

    xxx.xxx.xxx.exist

    xxxxxx已存在

    2

    10002

    xxx.xxx.xxx.not_exist

    xxxxxx不存在

    接口文档注意事项:

    1.url命名要尊重驼峰原则。

    2.接口文档要与接口相对应。

    3.get接口时,要把返回的成功样例写完整。

    4.get接口时,调用的样例一般只要

    http://localhost:8080/xxx/xxx/xxxx?page=1&size=10&name=a&type=1&status=1

    即可

    5.调用和返回的时间格式一般要统一。返回“yyyy-mm-dd HH:mm:ss”

    6.注意若传入参数和返回参数存在层级关系

    3.

    result
    Json

    N

     

    返回内容

     

    3.1

    Content
    List

    N

     

    数据list

     

    3.1.1

    id

    String

    Y

    32

    id

     

     在同一表格中用编号表示上下级

    展开全文
  • 接口文档规范的一些总结

    千次阅读 2019-03-17 23:49:48
    本人近期总结了一些接口文档规范。 参考文章如下:https://www.jianshu.com/p/dc0bc8613762 https://blog.csdn.net/fly1056601582/article/details/65935938 总结如下: 接口规范: RESTful a...
  • 【流程规范】API接口文档规范

    千次阅读 2018-07-06 14:37:18
    接口名称 前置主动还款申请(/payBill) 接口描述 接口地址:https://api.yidianfenqi.net/payBill 返回格式:json 请求方式:GET/ POST 请求示例:https://api.yidianfenqi.net/payBill?key=123456&...
  • JAVA接口规范.doc

    2019-09-19 15:05:19
    APP接口开发规范文档-V1.0,java接口开发规范 查询类接口是指客户端传递一些参数,服务端根据参数依据需求,前往数据库查询需要的结果返回数据的一类接口。 返回类型一般有两种。第一种是返回一个对象,第二种是返回...
  • java随手笔记:编写接口文档规范

    千次阅读 2019-01-31 17:18:29
    @java随手笔记:接口文档的格式 #作为一个新手会遇见各种问题,仅仅是为了自己以后丢失,方便观看!
  • restful接口文档模板

    2018-12-10 15:23:26
    RESTFUL接口文档模板,样式好看的接口文档模板,docx格式
  • 【IT修真院】接口文档规范以及示例

    千次阅读 2018-08-23 18:29:16
    所有项目接口文档,麻烦上心整理,文档不是给自己看的,只有自己才看得懂的文档就不要放上去浪费其他同学的时间了。 所有文档至少包含以下信息: 1.接口功能 2.接口路径 3.接口入参 4.接口出参 5.各字段说明、约定...
  • HTTP数据交互接口报文规范文档
  • 一 总则 ...5.文档更新规范接口统一规范说明 1.接口请求地址说明 2.平台公共参数说明 3.接口请求内容说明 4.接口返回内容说明 5.接口默认调用地址说明 • 正式环境 • 测试环境 三 接口详情 附录
  • 1.概述 2.接入说明 3.接口方法概述 4.接口方法详述 4.1.接口方法1(Test1) 4.2.接口方法2(Test2) 4.3.接口方法3(Test3) 5.代码映射表 5.1. 代码表1 5.2. 代码表2 5.3. 代码表3
  • 接口测试提测--接口文档规范

    万次阅读 2016-06-28 17:57:40
    接口测试的依据,往往不是需求文档,而是接口文档。 那么,接口文档的准确性便至关重要,本文推荐两种形式的接口文档,供大家参考。 接口文档不管以什么形式存在,需要包含的内容有: 接口名称接口类型输入...
  • 前后端接口文档规范模板

    千次阅读 2018-06-28 23:35:00
    xx系统接口V1 用户模块 user POST 新增用户 URL: /V1/user Request { "userName":"用户名(string,50,必填)", "password": "密码(MD5加密,必填)", "account": "账号", "userName": "用户...
  • 服务器接口文档规范,完整,事例,,,可查看http://blog.csdn.net/qq_36467463/article/details/79106409
  • 管理系统标准接口设计文档
  • REST它是一种使用URL来定位资源,使用HTTP请求描述操作的Web服务规范,本资源包含RESTful简介、设计原则、通用说明、规范细则、接口管理说明。
  • 网联接口开发文档规范,用于第三方支付机构的web服务开发等
  • 对接开票软件的接口文档,内涵注释
  • 阿里巴巴开发规范 一、编程规约 1 (一) 命名规约 1 (二) 常量定义 3 (三) 格式规约 4 (四) OOP 规约 6 (五) 集合处理 10 (六) 并发处理 12 (七) 控制语句 15 (八) 注释规约 16 (九) 其它 17 二、异常日志...
  • 对国家税务总局最新增值税发票接口规范V4.0中的电子发票接口规范进行测试,完善了其中遗漏的数据项,并成功导入了发票数据,现将测试完善后的示例代码予以公布。上述测试是针对电子收购发票进行的,普通的电子发票...
  • APP接口规范文档

    万次阅读 2018-04-11 11:54:29
    手机客户端接口文档   如果对您有帮助 ,请多多支持.多少都是您的心意与支持,一分也是爱,再次感谢!!!  支付宝赞赏:记得点击下面的余额宝,红包可能要大些。注意:余额宝红包有效期三天(72小时) 在有效...
  • 正确规范接口文档

    万次阅读 多人点赞 2018-05-17 14:14:27
    前言 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。下面我总结下自己看到的优秀接口文档。银联接口文档案例:5.2.2 统一收单线下交易查询...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 227,699
精华内容 91,079
关键字:

接口文档规范