更新时间:2021-12-17 GMT+08:00
分享

接口使用方法

联邦学习部署服务的FL-Client接口采用HTTPS传输协议,请求或响应的报文使用JSON报文,媒体类型表示为Application/json。

联邦学习部署服务FL-Client的API请求响应对,包括如下五个部分:

  • 请求URI
  • 请求消息头
  • 请求消息体
  • 响应消息头
  • 响应消息体

请求URI

URI格式

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

大多数语言或框架,都需要在请求消息中单独传递请求URI。

URI中的参数说明,如表1所示。
表1 参数说明

参数

描述

URI-scheme

用于传输请求的协议。

Endpoint

指定承载API服务端点的服务器域名或IP。

resource-path

资源路径,即API访问路径。从具体接口的URI模块获取,例如“v3/auth/tokens”。

Query string

可选参数,例如API版本或资源选择标准。

请求消息头

请求消息头包含如下两部分。

  • HTTP方法(也称为操作),表示请求操作的类型。
    表2 HTTP方法

    方法

    说明

    GET

    请求服务器返回指定资源。

    PUT

    请求服务器更新指定资源。

    POST

    请求服务器新增资源或执行特殊操作。

    DELETE

    请求服务器删除指定资源,如删除对象等。

    HEAD

    请求服务器资源头部。

    PATCH

    请求服务器更新资源的部分内容。

    当资源不存在的时候,PATCH可能会去创建一个新资源。

  • 可选的附加请求头字段,如指定的URI和HTTP方法所要求的字段。详细的公共请求消息头字段,请参见表3
    表3 公共请求消息头

    名称

    描述

    是否必选

    示例

    Content-Type

    消息体的类型(格式)

    application/json

请求消息体

请求消息体通常以结构化格式(如JSON格式)发出,与请求消息头中的“Content-type”对应,传递除请求消息头之外的内容。

若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。

响应消息头

响应消息头包含如下部分。

  • 附加响应头字段,如支持请求的响应所需,如“Content-type”响应消息头。详细的公共响应消息头字段,请参见表4
    表4 响应消息头

    名称

    描述

    示例

    Date

    HTTPS协议标准报头。表示消息发送的时间,时间的描述格式由rfc822定义。

    Mon, 12 Nov 2007 15:55:01 GMT

    Server

    HTTPS协议标准报头。包含了服务器用来处理请求的软件信息。

    Apache

    Content-Length

    HTTPS协议标准报头。用于指明实体正文的长度,以字节方式存储的十进制数字来表示。

    xxx

    Content-Type

    HTTPS协议标准报头。用于指明发送给接收者的实体正文的媒体类型。

    application/json

响应消息体

响应消息体通常以结构化格式(如JSON格式)返回,与响应消息头中的“Content-type”对应,传递除响应消息头之外的内容。

发起请求

共有三种方式可以基于已构建好的请求消息发起请求,分别为:

  • cURL

    cURL是一个命令行工具,用来执行各种URL操作和信息传输。cURL充当的是HTTP客户端,可以发送HTTP请求给服务端,并接收响应消息。cURL适用于接口调试。关于cURL详细信息请参见https://curl.haxx.se/

  • 编码

    通过编码调用接口,组装请求消息,并发送处理请求消息。

  • REST客户端

    Mozilla、Google都为REST提供了图形化的浏览器插件,发送处理请求消息。针对Firefox,请参见Firefox RESTClient。针对Chrome,请参见Chrome RESTClient

分享:

    相关文档

    相关产品

close