文档首页 > > API参考> 如何调用API> 构造请求

构造请求

分享
更新时间: 2020/03/20 GMT+08:00

请求示例如下所示,一个请求主要由请求URL、请求方法、请求消息头和请求消息体几部分组成,各个部分将在下文详细解释。

图1 请求示例图

请求URI

请求URI由如下部分组成。

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

尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。

  • URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。
  • Endpoint:指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。例如自然语言处理(NLP)服务在“华北-北京四”区域的Endpoint为“nlp-ext.cn-north-4.myhuaweicloud.com”。
  • resource-path:资源路径,也即API访问路径。从具体API的URI模块获取,例如“文本分类”API的resource-path为“/v1/{project_id} /nlu/classification”。其中{project_id}为项目编号,请参考获取项目ID获取。
  • query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。当前NLP服务未使用该参数。

例如,您需要在“华北-北京四”区域调用文本分类API,则需使用“华北-北京四”区域的Endpoint(nlp-ext.cn-north-4.myhuaweicloud.com),并在文本分类的URI部分找到resource-path(/v1/{project_id}/nlu/classification),拼接起来如下所示。

https://nlp-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/nlu/classification
图2 URI示意图

为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。

请求方法

HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。

  • GET:请求服务器返回指定资源。
  • PUT:请求服务器更新指定资源。
  • POST:请求服务器新增资源或执行特殊操作。
  • DELETE:请求服务器删除指定资源,如删除对象等。
  • HEAD:请求服务器资源头部。
  • PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。

文本分类的URI部分,您可以看到其请求方法为“POST”,则其请求为:

POST https://nlp-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/nlu/classification

请求消息头

附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。

如下公共消息头需要添加到请求中。

  • Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。
  • X-Auth-Token:用户Token,NLP服务使用Token方式认证,必须填充该字段。用户Token请参考3.2 认证鉴权

添加消息头后的请求如下所示。

POST https://nlp-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/nlu/classification
 
Content-Type: application/json
x-auth-token: MIIaBgYJKoZIhvcNAQcC……

请求消息体

请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。

对于文本分类接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,。

POST https://nlp-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/nlu/classification
 
Content-Type: application/json
x-auth-token: MIIaBgYJKoZIhvcNAQcC……
{    
     "content":"XXX去屑洗发水,全国包邮",
     "domain":1
}

到这里为止这个请求需要的内容就具备齐全了,您可以使用curlPostman或直接编写代码等方式发送请求调用API。对于文本分类接口,您可以从响应消息部分看到返回参数及参数说明。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问