精华内容
下载资源
问答
  • 接口文档示例
    千次阅读
    2020-12-30 11:53:46
    # ****项目后台API接口文档(比代码重要)
    
    ### API-V1 接口说明
    
    * 接口地址:http://hai.com/v1
    * 服务器已经全部开启CORS跨域支持
    * 使用HTTP Status Code为状态标识
    *  数据返回格式统一使用json格式 
    
    
    
    ### 支持的请求方法
    
    * GET(select) 从服务器获取资源
    * POST(create):在服务器创建资源
    * PUT(update):更新服务器资源
    * DELTE(delete):删除服务器资源
    
    
    
    ### 返回状态码说明
    
    | 状态码 | 含义      | 说明           |
    | ------ | --------- | -------------- |
    | 200    | OK        | 请求成功       |
    | 201    | create    | 创建成功       |
    | 404    | not found | 请求资源不存在 |
    
    
    
    ### 获取用户列表
    
    * 请求路径:/index
    * 请求方法:GET
    * 请求参数:空
    
    
    
    响应示例:
    
    | 参数名 | 参数说明 | 备注 |
    | ------ | -------- | ---- |
    | id     | 用户id   |      |
    | name   | 姓名     |      |
    | nengli | 能力     |      |
    | jituan | 集团     |      |
    
    ```json
    {
        "meta": {
            "status": 200,
            "msg": "Ok"
        },
        "data": [
            {
                "id": 1,
                "name": "飞",
                "nengli": "果实",
                "jituan": "草团",
                "img": ""
            },
            {
                "id": 2,
                "name": "孙",
                "nengli": "反馈",
                "jituan": "非常好",
                "img": ""
            }
        ]
    }
    

    获取单个用户信息

    • 请求路径: /getone/:id
    • 请求方法:GET
    • 请求参数:
    参数说明是否为空
    id用户id

    响应示例:

    参数名参数说明备注
    id用户id
    name姓名
    nengli能力
    jutuan集团
    {
        "meta": {
            "status": 200,
            "msg": "ok"
        },
        "data": {
            "id": 3,
            "name": "dd",
            "nengli": "花实",
            "jituan": "草团",
            "img": ""
        }
    }
    

    修改用户数据

    • 请求路径:/edit/:id

    • 请求方法:put

    • 请求参数:

      参数说明是否为空
      id用户idN
      name用户姓名Y
      nengli能力Y
      jituan集团Y

    响应示例

    参数参数说明备注
    data受影响行数
    {
        "meta": {
            "status": 200,
            "msg": "ok"
        },
        "data": 1
    }
    
    
     public function get_care_type_list(){
            $rs_data = Db::name('care_type')
                ->where('type_status',0)
                ->order('type_sort asc,type_id asc')
                ->field('type_id,type_name')
                ->select();
                //返回提示信息
            return ['code'=>1,'data'=>$rs_data];
        }
    
    更多相关内容
  • 接口文档示例
  • 接口文档示例.docx

    2019-08-13 16:34:08
    开发文档模版,便于后台技术开发人员与前端开发人员的交流
  • API接口文档范文-API接口文档示例

    千次阅读 2022-02-22 10:17:45
    本文主要是提供了一个接口文档的范文,内容修订历史、目录、时序图、接口要素描述、接口说明、使用示例、字典、FAQ。

     本文主要是提供了一个接口文档的范文,内容修订历史、目录、时序图、接口要素描述、接口说明、使用示例、字典、FAQ。
    使用MD格式文档(makedown),选择原因,容易格式转换,开发便于修改,版本维护界面,修改记录明显,普通文本工具即可编辑。

    下方是接口文档的示例:

    **API说明**

    ## 修订历史

    | 日期       | 内容                                                         | 版本     | 作者   |
    | ---------- | ------------------------------------------------------------ | -------- | ------ |
    | 2021/09/10 | 初稿                      | Ver. 1.0 | NHK|
     


    ## 目录 

    [TOC]

    ## 文档介绍
      本文档用于XXX业务的接口说明和使用说明。
     

    ### 功能时序图

    ```sequence
    API-> APISERVER: 系统连接
    APISERVER -> API: 连接成功
    API -> APISERVER: 系统登录
    APISERVER --> API: 登录成功
    API -> APISERVER: 业务请求
    APISERVER --> API: 业务响应
    API -> APISERVER: ......
    APISERVER --> API: ......
    API --> APISERVER: 系统连接断开
    APISERVER -> API: 系统连接断开响应
    ```

    ## 接口要素描述

    ### 术语定义

    - **JAVAGW:**系统的网关,有路由、广播等功能。
    - **JAVAAPI:**JAVA语言所调用的程序,提供JAVA语言的API接口。直接连接JAVAGW。
    - **APISERVER:**对外提供JSON格式接口,连接JAVAGW。
    - **C++API :**为C++语言提供的程序,连接APISERVER。
    - **PythonAPI:**为PythonAPI语言提供的程序,连接APISERVER。
    - **C#API :**为C#语言提供的程序,连接APISERVER。

    ### 语法描述

    #### 基础语法

    ​       接口使用JSON格式传输,语法规则遵循JSON语法规则。

    #### **描述语法**
    - **【0..0】:**表示无需赋值。
    - **【0..1】:**表示可以有0个或1个实例。
    - **【1..1】:**表示只能有一个实例。
    - **【1..*】:**表示至少有一个实例。
    - **【0..*】:**表示对实例的数目没有限制。
    - **【X.Y】:**表示X集合内的Y属性。示例:参数【orderList.exchId】,orderlist中exhcId的参数,订单集合中市场属性。
    - **【X^】:**表示X的集合中,有一个参数必送。示例:参数A ,参数标识【X^】 参数B ,参数标识【X^】 ,参数A、B必送一个。

    ### 数据类型

    int:整数类型

    long:长整型

    double:浮点类型

    String:字符串

    list:代表数组或集合

    ## 接口清单

    ### 功能列表

    | 接口  | 名称               | 接口支持 |
    | ----- | ------------------ | -------- |
    | 100000 | 功能1                         |[✔]JAVA[✔]python|
     

    #### 100000 -功能1

    ##### 接口定义

    ##### 注意事项

    ##### 参数说明

    请求参数

    | **参数**                                       | 中文名称                                       | **类型** | 长度  | 参数标识 | 示例值 |
    | ---------------------------------------------- | ---------------------------------------------- | -------- | ----- | -------- | ------ |
    | **value**                                     | 值1                                       | String   | 1     | 【1..1】 |        |
    | **ValueList**                      | 值对象列表                                     | list     | 999   | 【0..*】 |        |
    | **【ValueList.value1】**            | 值对象1                                     | String   | 35    | 【0..*】 |        |
    | **ValueList1**                      | 值列表1                                     | list     | 999   | 【0..*】 |        |

    响应参数

    | **参数**                                   | 中文名称     | **类型** | 长度 | 参数标识 | 示例值 |
    | ------------------------------------------ | ------------ | -------- | ---- | -------- | ------ |
    | [**successFlg**](#successFlg-成功失败标识) | 成功失败标志 | int      | 1    | 【1..1】 | 0      |
    | **errorCode**                              | 错误代码     | String   | 8    | 【0..1】 |        |
    | **failInfo**                               | 错误信息     | String   | 200  | 【0..1】 |        |
    | **value**                            | 存取值1号   | string   | 24   | 【1..*】 |        |

    ##### DEMO范例

    ###### JAVAAPI

    com.xxx..api.Interface.func(Funcvalue value)

    ```java
    .....
          
    ```

    ## 使用示例(业务场景)

    ### XXX业务使用用例说明

    #### 变更说明

    #### XXX示例

    ## 数据字典

    ### successFlg-成功失败标识

    |字典代码|名称|描述|
    |------|--------------|--------|
    |0|成功||
    |1|失败||
     

    ## FAQ

    展开全文
  • Java:接口文档示例

    千次阅读 2022-02-26 09:41:53
    接口概念 官方解释:Java接口是一系列方法的声明,是一些方法特征的集合,一个接口只有方法的特征没有方法的实现,因此这些方法可以在不同的地方被不同的类实现,而这些实现可以具有不同的行为(功能)。 我的解释:...

    接口概念

    官方解释:Java接口是一系列方法的声明,是一些方法特征的集合,一个接口只有方法的特征没有方法的实现,因此这些方法可以在不同的地方被不同的类实现,而这些实现可以具有不同的行为(功能)。

    我的解释:接口可以理解为一种特殊的类,里面全部是由全局常量和公共的抽象方法所组成。接口是解决Java无法使用多继承的一种手段,但是接口在实际中更多的作用是制定标准的。或者我们可以直接把接口理解为100%的抽象类,既接口中的方法必须全部是抽象方法。(JDK1.8之前可以这样理解)

    接口的特点

    就像一个类一样,一个接口也能够拥有方法和属性,但是在接口中声明的方法默认是抽象的。(即只有方法标识符,而没有方法体)。

    1.接口指明了一个类必须要做什么和不能做什么,相当于类的蓝图。
    2.一个接口就是描述一种能力,比如“运动员”也可以作为一个接口,并且任何实现“运动员”接口的类都必须有能力实现奔跑这个动作(或者implement move()方法),所以接口的作用就是告诉类,你要实现我这种接口代表的功能,你就必须实现某些方法,我才能承认你确实拥有该接口代表的某种能力。
    3.如果一个类实现了一个接口中要求的所有的方法,然而没有提供方法体而仅仅只有方法标识,那么这个类一定是一个抽象类。(必须记住:抽象方法只能存在于抽象类或者接口中,但抽象类中却能存在非抽象方法,即有方法体的方法。接口是百分之百的抽象类)
    4.一个JAVA库中接口的例子是:Comparator 接口,这个接口代表了“能够进行比较”这种能力,任何类只要实现了这个Comparator接口的话,这个类也具备了“比较”这种能力,那么就可以用来进行排序操作了。
    

    为什么要用接口

    1.接口被用来描述一种抽象。
    2.因为Java不像C++一样支持多继承,所以Java可以通过实现接口来弥补这个局限。
    3.接口也被用来实现解耦。
    4.接口被用来实现抽象,而抽象类也被用来实现抽象,为什么一定要用接口呢?接口和抽象类之间又有什么区别呢?原因是抽象类内部可能包含非final的变量,但是在接口中存在的变量一定是final,public,static的。
    

    接口文档规范

    0.示例代码
    1.接口说明
    2.接口地址
    3.请求方式
    4.请求参数
    5.响应参数
    6.成功示例
    7.异常示例
    

    0.示例代码

    @RestController
    @RequestMapping("/user")
    @Validated
    public class UserController{
    @GetMapping("/page-list")
    public Result getPageList(UserQueryDTO dto) {
    //to do…
    }
    }

    1.接口说明

    根据条件获取用户分页列表

    2.接口地址

    /user/page-list

    3.请求方式

    GET

    4.请求参数

    参数名称	         参数类型	         参数说明	          是否必传	     传参示例
    page	          Integer	       当前页码,不得小于1	    是	           1
    pageSize	      Integer	       每页大小,不得小于1	   是     	       10
    name	          String	           用户姓名	            否	         大土
    

    5.响应参数

    参数名称	        参数类型	                参数说明	                  参数示例
    code	         Integer	            响应编码        	           200
    message	          String	            响应消息	                   “ok”
    timestamp	      String	            响应时间	      “2021-02-03 12:12:12 122”
    data	         Object	                响应实体	       {“total”:66,“rows”:[“id”:1,“name”:“大土”,“age”:21]}
    total	          Long	               数据总量	                    66
    rows	          List	              每页数据集合   	[“id”:1,“name”:“大土”,“age”:21]
    id	              Long	               用户主键	                    1
    name	         String	               用户姓名   	               “大土”
    age	            Integer	               用户年龄	                   21
    

    6.成功示例

    //请求
    http://localhost:8080/user/page-list?page=1&pageSize=10

    //响应
    {
    “code”: 200,
    “message”: “ok”,
    “timestamp”: “2021-02-02 20:38:45 252”,
    “data”: {
    “total”: 66,
    “rows”: [
    “id”: 1,
    “name”: “大土”,
    “age”: 21
    ]
    }
    }

    7.异常示例

    //请求
    http://localhost:8080/user/page-list

    //响应
    {
    “code”: 400,
    “message”: “parameter can not be null:page”,
    “timestamp”: “2021-02-02 20:38:45 252”,
    “data”: null
    }

    展开全文
  • 接口文档示例

    2016-08-24 15:58:52
  • 移动端接口文档示例

    2016-08-25 09:43:52
    移动端接口文档示例
  • 接口文档示例,内包括html、word、excel等多种形式;1:app(android、ios、小程序)使用接口文档、2:mqtt接口文档、3:swagger生成接口文档
  • 接口文档模板.docx

    2020-05-06 12:52:20
    整理的超详细的接口测试文档,模板,教你怎么分析接口,怎么梳理接口文档整理的超详细的接口测试文档,模板,教你怎么分析接口,怎么梳理接口文档整理的超详细的接口测试文档,模板,教你怎么分析接口,怎么梳理接口...
  • 项目名称 项目信息接口模块名称 功能描述 获取项目基本信息整个项目信息模块的接口功能描述 返回说明统一的接口返回方式 参数名称 类型 描述 Code String 状态码 200 成功 404 错误 Msg String 信息描述 Data 返回的...
  • 接口文档示例(详解)

    千次阅读 2022-02-26 10:09:43
    文档示例 用户登录注册 登录 注册 树形菜单 增删查改 查 增 删 改 用户登录注册 登录 http请求方式: POST(请使用https协议) https://localhost:8080/hu/vue/userAction_login.action 参数 是否必须 说明...

    文档示例

    用户登录注册
        登录
        注册
    树形菜单
    增删查改
        查
        增
        删
        改
    

    用户登录注册
    登录

    http请求方式: POST(请使用https协议)
    https://localhost:8080/hu/vue/userAction_login.action
    
    参数	          是否必须	           说明
    uname	             是	              用户名
    upwd             	 是	               密码
    

    登录成功返回JSON数据包:

    {
       "msg":"登录成功",
    	"result":{
    	"uname":"你登录的用户名",
    	"pwd":"你登录的密码"
    },
    "code":1
    }
    

    如果登录成功code返回1,否则返回0,msg是提示信息
    说明:

    参数	                 说明
    msg	                    提示信息
    result	             登录的用户名和密码
    code	        登录时的状态:1成功,0失败
    

    注册

    注册返回JSON数据包:

    {
    "msg":"用户注册成功",
    "code":1
    }
    

    说明:

    参数	              说明
    msg	                 提示信息
    code	        注册状态:1成功,0失败
    

    树形菜单

    http请求方式: GET(请使用https协议)
    https://localhost:8080/hu/vue/treeNodeAction.action

    返回的json数据表如下:

    {
    “msg”: “操作成功”,
    “result”: [
    {
    “treeNodeId”: 1,
    “treeNodeName”: “系统管理”,
    “treeNodeType”: 1,
    “url”: null,
    “position”: 1,
    “icon”: “el-icon-setting”,
    “children”: [
    {
    “treeNodeId”: 2,
    “treeNodeName”: “用户管理”,
    “treeNodeType”: 2,
    “url”: “/sys/VuexPage1”,
    “position”: 2,
    “icon”: “el-icon-user”,
    “children”: []
    },
    {
    “treeNodeId”: 3,
    “treeNodeName”: “角色管理”,
    “treeNodeType”: 2,
    “url”: “/sys/VuexPage2”,
    “position”: 3,
    “icon”: “”,
    “children”: []
    },
    {
    “treeNodeId”: 4,
    “treeNodeName”: “密码修改”,
    “treeNodeType”: 2,
    “url”: null,
    “position”: 4,
    “icon”: null,
    “children”: []
    }
    ]
    },
    {
    “treeNodeId”: 5,
    “treeNodeName”: “论坛管理”,
    “treeNodeType”: 1,
    “url”: null,
    “position”: 5,
    “icon”: “el-icon-reading”,
    “children”: [
    {
    “treeNodeId”: 6,
    “treeNodeName”: “文章管理”,
    “treeNodeType”: 2,
    “url”: “/sys/Articles”,
    “position”: 6,
    “icon”: null,
    “children”: []
    }
    ]
    }
    ],
    “code”: 1
    }

    说明:

    参数	            说明
    msg	               消息提示
    result           	结果集
    code	      状态:1成功,2失败
    

    增删查改

    http请求方式: POST(请使用https协议)
    http://localhost:8080/hu/vue/articleAction_list.action

    参数	   是否必须    	    说明
    page	      否	     页数:默认是1
    rows	      否	     行数:默认是10
    title	      否	      查询条件
    

    正确时返回JSON数据包:

    {
    “result”:[{“id”:1,“title”:“vue教程”,“body”:“vue是一个很牛逼的框架”],
    “pageBean”:{
    “page”:2,
    “rows”:1,
    “total”:0,
    }
    }

    result结果集

    参数	     说明
    title	    文章标题
    body	    文章内容
    ID	        文章ID
    

    pageBean

    参数	     说明
    page	     页数
    rows	     每页的数量
    total	     总条数
    

    http请求方 式: POST(请使用https协议)
    http://localhost:8080/hu/vue/articleAction_add.action

    参数	      是否必须	     说明
    ID	             否	       文章ID
    title	         是	      文章标题
    body	         是	      文章内容
    

    正确时返回JSON数据包:

    {“msg”:“新增成功”,“result”:[],“code”:1}

    参数	          说明
    msg     	    消息提示
    code	     状态:1成功,0失败
    

    http请求方式: POST(请使用https协议)
    http://localhost:8080/hu/vue/articleAction_del.action

    参数	       是否必须	       说明
    ID	              是	       文章ID
    

    正确时返回JSON数据包:

    {“msg”:“删除成功”,“code”:1}

     参数	          说明
     msg	         消息提示
    code	     状态:1成功,0失败
    

    http请求方式: POST(请使用https协议)
    http://localhost:8080/hu/vue/articleAction_edit.action

    参数	       是否必须	       说明
    ID	              是	      文章ID
    title	          是	     文章标题
    body	          是	     文章内容
    

    正确时返回JSON数据包:

    {“msg”:“修改成功”,“code”:1}

    参数	           说明
    msg	              消息提示
    code	    状态:1成功,0失败
    
    展开全文
  • Markdown 接口文档示例

    千次阅读 2019-12-07 14:05:54
    开发过程中经常需要整理接口并且写一份接口文档,这是使用MarkDown写的一份示例,先预览下样子: 接口列表 接口 说明 /p/global/strategy 请求全局策略 /p/user/userLogin 用户登录接口 错误码列表 ...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 235,724
精华内容 94,289
关键字:

接口文档示例

友情链接: Sample_Code-MC-CDMA.zip