普通接口

  1. 所有接口均需要登录后请求,否则会响应401
  2. 所有接口返回数据都是json格式

成功示例:

{
    "code": 200,
    "succeed": true,
    "data": ?
}

失败示例:

{
    "code": 400,
    "succeed": false,
    "message": ""
}

其中Code和HttpCode必定相同,所有成功的响应码都是200,失败的时候会有几种情况:

  1. 401表示需要登录
  2. 400表示客户端的一些参数或者数据格式错误
  3. 500表示服务器发生内部错误,大多数情况是客户端参数缺失造成
  4. Data返回的是客户端提交的参数,Message是错误描述,方便客户端排查原因。

接口列表

以下接口全部支持OPTIONS请求方法,其中仅/method/get支持HEAD请求。

/login

登录接口,登录成功后会在响应头设置Cookie,内容是登录帐号的Session信息,客户端应该根据Http标准协议实现。

参数名 是否必须 含义
name 用户名
password 密码

帐号和密码随便输,只要非空即可。

成功时响应:

{
    "code": 200,
    "succeed": true
}

/redirect

重定向接口,注意获取Header中的Location。

  • Code:300/301/302/303/307/308的任意一个。
  • Location:http://www.example.com/xx/yy/xx/yyxx/yy../xx/yy的任意一个。

说明:由于../xx/yy此格式在/redirect中无法定位到,所以不会返回,但是客户端应该考虑这种情况,比如访问http://www.example.com/ll/mm/nn/时,服务器返回Location是../xx/yy,那么客户端应该得出http://www.example.com/ll/xx/yy

/method/get

测试GET请求的接口。

参数名 是否必须 含义
name 名称
age 年龄

两个值随便输,允许空。

成功时响应:

{
    "code": 200,
    "succeed": true,
    "data": {
        "name": 123,
        "password": 456
    }
}

/method/post

测试POST请求的接口。

参数名 是否必须 含义
name 名称
age 年龄

两个值随便输,允许空。

成功时响应:

{
    "code": 200,
    "succeed": true,
    "data": {
        "name": 123,
        "password": 456
    }
}

/method/put

测试PUT请求的接口。

参数名 是否必须 含义
name 名称
age 年龄

两个值随便输,不允许空。

成功时响应:

{
    "code": 200,
    "succeed": true,
    "data": {
        "name": 123,
        "password": 456
    }
}

/method/delete

测试DELETE请求的接口。

参数名 是否必须 含义
name 名称
age 年龄

两个值随便输,允许空。

成功时响应:

{
    "code": 200,
    "succeed": true,
    "data": {
        "name": 123,
        "password": 456
    }
}

/method/patch

测试PATCH请求的接口。

参数名 是否必须 含义
name 名称
age 年龄

两个值随便输,允许空。

成功时响应:

{
    "code": 200,
    "succeed": true,
    "data": {
        "name": 123,
        "password": 456
    }
}

/get/list

获取分页列表数据,请求方法为GET。

参数名 是否必须 含义
pageNum 请求的页码,第几页
pageSize 每页Item条数
{
    "code": 200,
    "data": {
        "dataList": [
            {
                "title": "I am title 0.",
                "content": "I am content 0."
            },
            {
                "title": "I am title 1.",
                "content": "I am content 1."
            },
            ...
        ],
        "page": {
            "pageNum": 1,
            "pageSize": 50,
            "totalSize": 500,
            "pageCount": 10
        }
    },
    "succeed": true
}

results matching ""

    No results matching ""