后端(XXB)服务器 HTTP 接口

2019-11-04 16:09:04
先知
79
最后编辑:先知 于 2019-11-22 09:32:49

后端服务与 XXD 服务通过 HTTP 协议进行通信,通常情况下由 XXD 服务向后端服务发起一个 HTTP 请求,后端服务根据请求中包含的数据包定义进行相关操作,并同样以数据包的形式返回操作结果。

目前后端服务只需要提供一个 HTTP 接口。

XXD 服务器通过此接口 POST 一个文本文件,后端服务器获取文件内容为字符串,使用约定的解密算法解析字符串的原始内容,并尝试将字符串通过 JSON 格式转换为一个对象。

该对象即为数据包定义对象。后端服务器根据数据包定义对象中的信息进行处理,处理完毕后返回一个新的数据包定义对象或者由多个数据包组成的数组,将此对象或数组使用 JSON 系列化为字符串后再使用约定的算法进行加密,然后随着请求返回加密后的内容到 XXD 服务。

一次典型的从客户端调用后端 API 的过程如下图:

sequenceDiagram xxc->>xxd: 客户端发送请求数据包(socket) xxd->>xxb: 将请求数据包转发给后端服务(http) Note right of xxb: 后端服务器解析
并处理请求数据包 xxb-->>xxd: 将处理结果以响应数据包(或数据包组)返回给 XXD(http) xxd-->>xxc: 将后端返回的响应数据包(或数据包组)发送给客户端(socket)

官方在 XXB 系统实现的接口地址通常为http://xxbserver.com/x.php。

发表评论
评论通过审核后显示。