API 如何创建？
创建 API 即录入 API 的定义，支持“入参映射”和“入参透传”两种请求模式。
创建API
创建 API 需要录入 API 的基本信息、服务信息、请求信息、返回信息。
此外，网关支持您配置常量参数、系统参数，这些参数对您的用户不可见，但是网关可以在中转时将常量参数、系统参数加入请求中，传递至后端服务，满足您后端的一些业务需求。比如您需要网关每次向您发送请求都带有一个 keyword[backcolor=transparent]aligateway，您就可以把 [backcolor=transparent]aligateway 配置为常量参数，并指定接收的位置。
第一部分：定义请求的基本信息
[backcolor=transparent]API 基本信息包括 API 分组、 API 名称、安全认证方式、 API 类型、描述。
- API 创建时需要选择分组。分组是 API 的管理单元，创建 API 之前您需要先创建分组（ API 分组的详细说明见 API 开放），选择分组即选择 [backcolor=transparent]Region。
- API 名称：API名称标识，需要手工录入。
安全认证方式：是 API 请求的认证方式，目前支持 [backcolor=transparent]阿里云APP、[backcolor=transparent]OpenID Connect 和 [backcolor=transparent]无认证 三种认证方式。- [backcolor=transparent]阿里云APP：认证方式即要求请求者调用该 API 时能够通过对APP的身份认证。
- [backcolor=transparent]OpenID Connect：是一套基于 OAuth 2.0 协议的轻量级规范，提供通过RESTful APIs 进行身份交互的框架。可以使用OpenID Connect和您的自有账号系统无缝对接，详细介绍请参照 OpenID Connect。
- [backcolor=transparent]无认证：认证方式即任何人知晓该 API 的请求定义后，均可发起请求，网关不对其做身份验证，均会转发至您后端服务。（强烈不建议使用此模式）
API 类型分为公开和私有两种。
1.[backcolor=transparent]私有 类型的 API ，当所在分组上架云市场时，默认不包括该类型的 API 。如果有用户想要调用您的 API ，您需要主动操作授权，否则用户无渠道获取 API 信息。2.[backcolor=transparent]公开 类型的 API ，所有用户均有机会在 发现 API 页面看到 API 的部分信息。[backcolor=transparent]公开 类型的 API 都会跟 API 分组上架到云市场，供用户购买和调用。- 描述： API 功能描述，会生成在 API 文档中。
第二部分：定义 API 请求
这部分是定义用户如何请求您的 API ，包括协议、Method、Path、入参的定义。
- 协议。 API 调用支持 HTTP/HTTPS 协议。
Method。支持标准的 HTTP Method，可选择 PUT、GET、POST、DELETE、HEAD。
[backcolor=transparent]Path。Path 指相对于服务 host， API 的请求路径。请求 Path 可以与后端服务实际 Path 不同，您可以随意撰写合法的有明确语义的 Path 给用户使用。您可以在请求 Path 中配置动态参数，即要求用户在 Path 中传入参数，同时您的后端又可以不在 Path 中接收，可以映射为在 Query、Header 等位置接收。在 开放 API 接入 API 网关 中，有详细的举例说明，更有清晰的截图展示。- [backcolor=transparent]入参请求模式。网关对入参的处理模式，支持“入参映射”和“入参透传”两种模式。
- [backcolor=transparent]入参映射：既 API 网关在接收到您的 API 请求时，通过映射关系将请求转换成您后端需要的格式。使用入参映射模式：定义方式：此类API需要在定义时添加前后端参数映射关系。
- 使用场景同一接口，在 API 网关定义不同的API，以服务差异化的用户；
- 通过 API 网关规范化陈旧系统接口。
- 实现功能
- 支持您配置前端和后端的全映射，即参数混排。可以让 API 的消费者在 [backcolor=transparent]Query 传入参数, 后端从 [backcolor=transparent]Header 里接收等。参数名称转换
- 参数位置转换
- 可以定义参数的校验规则，实现请求参数的预校验，降低后端处理非法请求的压力。
- 参数长度校验
- 参数数值大小校验
- 参数正则校验
- 参数Json Schame校验
- 入参透传：即 API 网关在接收到 API 请求后，不对请求进行处理，直接转发到后端服务。此模式下：
- 无法实现参数校验
- 无法生成详细的 API 调用文档
- 自动生成的SDK不包含请求入参
- 参数名。展示给用户的参数名称。
- 参数位置。参数在请求中的位置，包含Head、Query、Body、Path（Parameter Path），当您在 Path 中配置了动态参数，存在参数位置为Parameter Path的同名参数。
- 类型。字段的类型，支持：String、Int、Long、Float、Double、Boolean。
- 是否必填。指此参数是否为必填指，当选择为是时，网关会校验用户的请求中是否包含了此参数，若不存在则拒绝用户请求。
- 默认值。当“是否必填”为否时生效，在用户请求中不包含此参数时，网关自动添加默认值给后端服务。若用户传递，则按用户请求传递给后端服务。
- 示例。指参数的填写示例，生成 API 文档、上架 API 市场时的参数示例。
- 描述。参数的用途描述及使用的注意事项，生成API文档、上架API市场时的参数描述。
- [backcolor=transparent]参数校验规则。每个入参后可点击 [backcolor=transparent]编辑更多 配置校验规则。如参数值的长度、取值大小、枚举、正则、Json Shcame等等。网关会参照校验规则对请求做初步校验，如果入参不合法，则不会到达您的后端服务，大大的降低了后端服务的压力。
第三部分：定义后端服务信息
这部分主要是定义一些参数的前后端映射，具体描述的是您后端真实服务的 API 配置。用户请求到达网关后，网关会根据您的后端配置映射为对应实际后端服务的请求形式，去请求您的后端。包括后端服务地址、后端Path、后端超时时间、参数映射、常量参数、系统参数。
- 后端服务类型。目前支持HTTP/HTTPS、FunctionCompute两种。HTTP/HTTPS。若您的服务为HTTP/HTTPS服务，则选择此项。注意若您是HTTPS服务，后端服务必须有SSL证书。
- FunctionCompute。为阿里云函数计算，使用方法请参照：以函数计算作为 API 网关后端服务
系统参数。指 API 网关的系统参数，这些参数默认不会传递给您，但是如果您需要获取，您可以在 API 里配置接收位置和名称。具体内容如下表：
| 参数名称 | 参数含义 |
| CaClientIp | 发送请求的客户端IP |
| CaDomain | 发送请求的域名 |
| CaRequestHandleTime | 请求时间（格林威治时间） |
| CaAppId | 请求的APP的ID |
| CaRequestId | RequestId |
| CaApiName | API 名称 |
| CaHttpSchema | 用户调用 API 使用的协议，http或者https |
| CaProxy | 代理（AliCloudApiGateway） |
[backcolor=transparent]注意：您所有录入的参数，包括 Path 中的动态参数、Headers 参数、Query 参数、Body 参数（非二进制）、常量参数、系统参数，参数名称保证全局唯一。即如果您同时在 Headers 和 Query 里各有一个名为 [backcolor=transparent]name 的参数，是不允许的。
第四部分 定义返回结果
您需要录入返回ContentType、返回结果示例、失败返回结果示例和错误码定义，将会生成 API 文档和在 API 市场的展示。
API调试
API 定义录入完成后，您可以在API调试页面调试API，以确定 API 的可用性。
发布
完成以上定义后，您就完成了 API 的创建。下一步您可以测试、发布、开放 API 服务到市场，还可以为 API 绑定 签名密钥和 流量控制等安全配置。
展开
收起
版权声明：本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
相关问答
