开发者社区 问答 正文

如何创建 API?


API 分组创建完成您就可以创建 API 了,创建 API 是定义 API 请求的过程。您需要在创建中依次定义以下内容:

  1. API 的基本信息:分组、API 名称、API 类型、API 认证方式、描述。
  2. API 请求:协议、Method、Path、入参。
  3. API 服务:后端服务协议、后端服务 Method、后端服务地址、后端服务 Path、服务超时时间、参数映射、系统参数、常量参数。
  4. API 返回结果:返回类型及示例,目前网关对于返回结果不做处理,直接透传给请求者。后续会支持用户定制化、格式化的定义返回信息。

至此完成 API 的创建,并且具备开放的条件。操作详细说明请看 使用手册(开放API)

展开
收起
轩墨 2017-10-26 11:38:11 1680 分享 版权
阿里云 AI 助理回答

在阿里云API网关中创建API是一个细致且关键的过程,它涉及定义API的多个方面以确保其能够正确、高效地服务于客户端请求。以下是创建API的详细步骤和配置要点:

API基本信息配置

  1. 分组选择:首先,在已创建的API分组列表中选择一个合适的分组作为新API的归属。分组有助于按照业务逻辑或系统架构组织API,实现更好的管理与访问控制。

  2. API名称:为API指定一个具有辨识度的名称,通常反映其功能或服务内容,支持字母、数字及特定符号组合,长度限制在32字符内。

  3. API类型:根据后端服务的特性选择合适的API类型,如HTTP、MPC等,这决定了API调用的基本协议和交互模式。

  4. 认证方式:配置API的安全认证机制,可选无认证、AppKey、JWT等多种方式,确保API调用的安全性。例如,若选择阿里云APP认证,则需配置AppCode允许通过Header或Query参数传递进行身份验证。

  5. 描述信息:提供一段简短说明,概述API的功能、用途或调用注意事项,帮助开发者快速理解API的作用。

API请求定义

  1. 协议与Method:确定客户端发起请求时使用的协议(HTTP/HTTPS)及请求方法(GET、POST等),以匹配后端服务的接口规范。

  2. Path与Method映射:设置前端请求路径(Path)以及对应的HTTP Method,这是客户端调用API的直接入口。

  3. 入参配置:定义请求的参数结构,包括请求模式(如表单、JSON)、参数名、类型及是否必填,确保API能准确接收并解析客户端传入的数据。

API后端服务配置

  1. 后端服务协议与Method:指定后端服务的通信协议及处理请求的方法,应与前端配置保持一致或兼容。

  2. 后端服务地址与Path:填写后端服务的实际URL地址及Path,确保API网关能够路由至正确的服务端点。

  3. 超时时间:设定从API网关向后端发送请求的超时时间,避免长时间等待响应导致用户体验下降,默认值通常是3000毫秒。

  4. 参数映射:配置如何将前端请求参数转换并传递给后端服务,包括系统参数、常量参数的处理规则,保证数据的准确传输。

API返回结果

当前,API网关对返回结果不做格式化处理,直接透传后端服务的响应给客户端。这意味着开发者需要确保后端服务的返回格式符合客户端的预期。未来,平台可能会支持更灵活的返回结果定制功能。

注意事项

  • 在配置跨VPC HTTP服务时,需关注地域限制、证书要求及安全组设置。
  • 使用自定义域名时,注意绑定与测试限制,并考虑正式环境下的独立域名使用。
  • 安全措施如签名验证、IP访问控制等需根据实际需求仔细配置,以保障API的安全性。

综上所述,创建API是一个涵盖多维度配置的过程,每一步都需根据具体业务场景细心规划与实施,确保API的稳定、安全运行。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答
问答分类:
API
问答标签:
问答地址: