关于Web API

Web API是一个用于构建HTTP服务的框架,它可以访问广泛的客户端,包括浏览器和移动设备。

基本URL

以下是基本URL:

<协议>://<域名>:<端口号>/api/v1

登录

输入用户名和密码以获取令牌。使用“安全”时,令牌用于授权。

注:  基于令牌的身份验证是一种安全技术,它使用服务器提供的安全令牌对试图登录到服务器、网络或其他安全系统的用户进行身份验证。

概述

请求

项目
方法POST
URL<Base URL>/login
参数N/A
标题 内容类型,内容长度
标题
Content-Type application/json
正文 JSON
字段 数据类型 备注
username字符串 用户名
password字符串 密码
示例

POST http://192.168.1.100:8000/api/v1/login HTTP/1.1

Host: localhost:8082

Content-Type: application/json

content-length: 44

{

"username":"User1",

"password":"Pass1"

}

注:示例代码用Java编写。

响应

项目
状态代码 验证成功,人机界面将发送200 (OK)。
代码
200 OK成功验证
401 Unauthorized验证失败
标题 内容类型,传输编码
标题
Content-Type application/json
Transfer-Encoding Chunked
正文 JSON
字段 数据类型
token 字符串 已验证令牌
示例

 

0

注:示例代码用Java编写。