精华内容
下载资源
问答
  • 接口文档示例

    万次阅读 多人点赞 2019-08-15 17:15:40
    接口文档示例用户登录注册登录注册树形菜单增删查改查增删改 用户登录注册 登录 http请求方式: POST(请使用https协议) https://localhost:8080/hu/vue/userAction_login.action 参数 是否必须 说明 uname...

    用户登录注册

    登录

    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失败
    展开全文
  • 移动端接口文档示例

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

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

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

    接口列表

    接口说明
    /p/global/strategy请求全局策略
    /p/user/userLogin用户登录接口

    错误码列表

    错误码说明
    0正确
    1错误
    2参数错误

    接口详情

    • 全局策略

      • 接口地址:/p/global/strategy

      • 返回格式:Json

      • 请求方式:Post

      • 请求示例:http://www.baidu.com/p/global/strategy

      • 接口备注:通过用户信息,请求获得全局策略。

      • 请求参数说明:

        名称类型必填说明
        markingstringtrue企业标识
        accountstringtrue用户名
        pwstringtrue用户密码
      • 返回参数说明:

        名称类型说明
        rtint状态码
        dataobject具体数据
        identify_methodint登录方式
        send_urlstring推送地址
      • JSON返回示例:

      •    {
               "rt": 0,
               "data": {
                   "identify_method": "3",
                   "send_url": "www.jianshu.com"
               }
           }
        

         


    • 登录接口

      • 接口地址:/p/global/login

      • 返回格式:Json

      • 请求方式:Post

      • 请求示例:http://www.baidu.com/p/global/login

      • 接口备注:通过用户信息,请求获得全局策略。

      • 请求参数说明:

        名称类型必填说明
        markingstringtrue企业标识
        accountstringtrue用户名
        pwstringtrue用户密码
      • 返回参数说明:

        名称类型说明
        rtint状态码
        dataobject具体数据
        identify_methodint登录方式
        send_urlstring推送地址
      • JSON返回示例:

      •    {
               "rt": 0,
               "data": {
                   "identify_method": "3",
                   "send_url": "www.jianshu.com"
               }
           }

      • 在简书的MarkDown编辑器中不支持部分标签,如不支持锚点:<span></span>,颜色:<font color=red>等,预览效果是删除了这部分。
      • MarkDown的语法
      • 初始文件:
      •  ## 接口列表
        
        |  接口  | 说明 |
        |------ |----- |
        |[/p/global/strategy](#strategy)| 请求全局策略|
        |[/p/user/userLogin](#login) | 用户登录接口|
        
        ***
        ##错误码列表
        |  错误码  | 说明 |
        |------ |----- |
        |   0   | 正确 |
        |   1   | 错误 |
        |   2   | 参数错误|
        
        ## 接口详情
        * <span id = "strategy">全局策略</span>
        
            * 接口地址:/p/global/strategy
        
            * 返回格式:Json
        
            * 请求方式:Post
        
            * 请求示例:http://www.baidu.com/p/global/strategy
        
            * 接口备注:通过用户信息,请求获得全局策略。
        
            * 请求参数说明:
        
                | 名称 | 类型 | 必填 |说明|
                |----- |------| ---- |----|
                |marking |string|true|企业标识|
                |<font color=red>account | string |true|用户名|
                |<font color=red>pw | string |true|用户密码|
        
            * 返回参数说明:
        
                | 名称 | 类型 |说明|
                |----- |------|----|
                | rt | int|状态码
                |data | object|具体数据|
                |identify_method | int|登录方式|
                |send_url | string|推送地址|
        
            * JSON返回示例:
        
                     {
                         "rt": 0,
                         "data": {
                             "identify_method": "3",
                             "send_url": "www.jianshu.com"
                         }
                     }
        
        
        ---
        
        * <span id = "login">登录接口</span>
        
            * 接口地址:/p/global/login
        
            * 返回格式:Json
        
            * 请求方式:Post
        
            * 请求示例:http://www.baidu.com/p/global/strategy
        
            * 接口备注:通过用户信息,请求获得全局策略。
        
            * 请求参数说明:
        
                | 名称 | 类型 | 必填 |说明|
                |----- |------| ---- |----|
                |marking |string|true|企业标识|
                |<font color=red>account | string |true|用户名|
                |<font color=red>pw | string |true|用户密码|
        
            * 返回参数说明:
        
                | 名称 | 类型 |说明|
                |----- |------|----|
                | rt | int|状态码
                |data | object|具体数据|
                |identify_method | int|登录方式|
                |send_url | string|推送地址|
        
            * JSON返回示例:
        
                     {
                         "rt": 0,
                         "data": {
                             "identify_method": "3",
                             "send_url": "www.jianshu.com"
                         }
                     }
        
        
        ---

         

    展开全文
  • 后台接口文档示例

    千次阅读 2019-09-28 05:08:39
    什么是接口文档? 在项目期间,前后端是分离开发的,为了前后有连贯性,就必须由前后开发工程师共同定义接口、写接口文档再根据接口文档去开发,一直到项目结束。 接口文档规范 方法  也就是我们常写的...

    什么是接口文档?

    在项目期间,前后端是分离开发的,为了前后有连贯性,就必须由前后开发工程师共同定义接口、写接口文档再根据接口文档去开发,一直到项目结束。

    接口文档规范

    • 方法

      也就是我们常写的新增,删除,修改,查询

    • url

      调用方法,一般是从前端调后端的方法地址

    • 请求参数

      一般分五列:字段、说明、类型、备注、是否必填 

    • 返回参数

      1、如果只返回接口调用成功还是失败(新增、删除、修改等),则只有一个结构体:

          code和message两个参数;

      2、如果要返回某些参数,则有两个结构体:

          是code/mesage/data;

            是data里写返回的参数,data是object类型;

      3、如果要返回列表,那么有三个结构体,

              是code/mesage/data,data是object,里面放置page/size/total/totalPage/list 5个参数,其中list是Arrary类型,list里放object,object里是具体的参数。

    了解目的

    1. 用户登录
    2. 用户注册
    3. 树形菜单
    4. 文章查询
    5. 文章新增
    6. 文章修改
    7. 文章删除

    用户登录:

      接口调用and请求

    http请求方式: POST    (一般有两种get/post)
    https://xxx.xxx.xxx:8080/项目命名/vue/userAction_login.action
    字段说明类型是否必填
    uname名字String
    pwd密码String

    登录成功返回JSON数据包:
    {
        "msg":"登录成功",
        "result":{
            "uname":"用户名",
            "pwd":"密码"
        },
        "code":1
    }

    用户或者密码为空返回JSON数据包:

    {    
        "msg":"用户或者密码为空",
        "result":{
            "uname":"用户名",
            "pwd":"密码"
        },
        "code":0
    }

    用户或者密码错误返回JSON数据包:

    {
        "msg":"用户或者密码错误",
        "result":{
            "uname":"用户名",
            "pwd":"密码"
        },
        "code":0
    }

    参数

    说明

    msg

    提示消息

    result

    返回登录的用户名和密码

    code

    状态 0:登录失败 1:登录成功

    用户注册

      接口调用

    https://xxx.xxx.xxx:8080/项目命名/vue/userAction_reg.action
    字段说明类型是否必填
    uname名字String
    pwd密码String

    注册返回JSON数据包:

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

    用户注册失败返回JSON数据包:

    {
        "msg":"用户注册失败",
        "code":0
    }
     
     
     
     

    参数

    说明

    msg

    提示消息

    code

    状态码 0:失败 1:成功

    树形菜单

    调用接口

    https://xxx.xxx.xxx:8080/项目命名/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

    状态 0:失败 1:成功

    Result树形菜单结果集

    参数

    说明

    treeNodeId

    菜单id

    treeNodeName

    菜单名

    treeNodeType

    菜单类型 1:父菜单2:跳转菜单

    url

    路由地址

    icon

    菜单图标

    children

    子菜单集,如果没有则为一个空json数组

    文章查询

    调用接口

    https://xxx.xxx.xxx:8080/项目命名/vue/articleAction_list.action

    参数

    是否必填

    说明

    page

    当前页码,默认为1

    rows

    一页展示多少条数据,默认为10

    title

    按文章标题查询

    返回json数据包说明:

    {
        "result":[{"id":1,"title":"文章标题","body":"文章内容"],
        "pageBean":{
            "page":1,
            "rows":10,
            "total":100,
        }
    }

    result结果集

    参数

    说明

    id

    文章id

    title

    文章标题

    body

    文章内容

    pageBean 分页对象说明

    参数

    说明

    page

    当前页码

    rows

    一页展示的条数

    total

    总条数

    文章添加

    调用接口

    https://xxx.xxx.xxx:8080/项目命名/vue/articleAction_add.action

    参数

    是否必填

    说明

    title

    文章标题

    Body

    文章内容

    添加成功返回JSON数据包:

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

    添加失败返回JSON数据包:

    {"msg":"新增失败","result":[],"code":0}

    参数

    说明

    msg

    提示消息

    code

    状态码 0:失败 1:成功

    文章修改

    调用接口

    https://xxx.xxx.xxx:8080/项目命名/vue/articleAction_edit.action

    参数

    是否必须

    说明

    id

    文章id

    title

    文章标题

    body

    文章内容

    修改成功返回JSON数据包:

    {"msg":"修改成功","code":1}

    修改失败返回JSON数据包:

    {"msg":"修改失败","code":0}

    参数

    说明

    msg

    提示消息

    code

    状态码 0:失败 1:成功

    文章删除

    调用接口

    https://xxx.xxx.xxx:8080/项目命名/vue/articleAction_del.action

    参数

    是否必须

    说明

    id

    文章id

    删除成功返回JSON数据包:

    {"msg":"删除成功","code":1}

    删除失败返回JSON数据包:

    {"msg":"删除失败","code":0}

    参数

    说明

    msg

    提示消息

    code

    状态码 0:失败 1:成功

     

     

    谢谢观看!

    转载于:https://www.cnblogs.com/huangting/p/11371951.html

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

    千次阅读 2021-02-03 20:24:40
    接口文档规范0.示例代码1.接口说明2.接口地址3.请求方式4.请求参数5.响应参数6.成功示例7.异常示例 0.示例代码 @RestController @RequestMapping("/user") @Validated public class UserController{ @GetMapping("/...

    0.示例代码

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

    1.接口说明

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

    2.接口地址

    /user/page-list

    3.请求方式

    GET

    4.请求参数

    参数名称参数类型参数说明是否必传传参示例
    pageInteger当前页码,不得小于11
    pageSizeInteger每页大小,不得小于110
    nameString用户姓名大土

    5.响应参数

    参数名称参数类型参数说明参数示例
    codeInteger响应编码200
    messageString响应消息“ok”
    timestampString响应时间“2021-02-03 12:12:12 122”
    dataObject响应实体{“total”:66,“rows”:[“id”:1,“name”:“大土”,“age”:21]}
    totalLong数据总量66
    rowsList每页数据集合[“id”:1,“name”:“大土”,“age”:21]
    idLong用户主键1
    nameString用户姓名“大土”
    ageInteger用户年龄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
    }
    
    展开全文
  • 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
  • 接口设计文档示例

    2014-07-17 16:57:17
    一份非常优秀的接口设计文档,是有关支付宝集分宝的。小伙伴们还在等待什么呢?赶紧下载吧?
  • 高拍仪各种接口文档说明和示例,包含人脸识别和身份证和发票等拍照,个人已经实践使用,高拍仪各种接口文档说明和示例,包含人脸识别和身份证和发票等拍照,个人已经实践使用

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 208,564
精华内容 83,425
关键字:

接口文档示例