如何在JavaScript版AWS Amplify REST API中使用路径参数
Amplify 路径参数类REST接口的使用说明
功能可用性判定
- 你提到的2月21日完成代码合并的路径参数支持功能,已在Amplify CLI 4.28.0及以上正式版本中全量可用,不存在功能阻塞
- 关联问题项携带的
pending-review标签,仅代表对应的官方文档补全内容还在审核流程,不代表核心代码能力处于待上线状态,无需担心功能不可用
具体使用方法
1. Amplify托管REST API的配置
通过amplify add api创建REST接口绑定Lambda/托管后端时,路由配置直接填写带占位符的路径格式即可,例如直接写/user/{id},CLI会自动为API网关生成路径参数匹配规则,参数值会自动注入到触发函数的事件对象中。
2. 前端代码调用方式
使用Amplify JS SDK发起请求时,无需手动拼接动态路径字符串,直接传入带占位符的路由地址,在请求配置中通过pathParameters字段映射实际参数值即可,示例代码:
import { API } from 'aws-amplify'; // 调用/user/{id}格式的接口 const userRes = await API.get('你的API逻辑名', '/user/{id}', { pathParameters: { id: '目标用户ID值' }, queryStringParameters: {} // 其他查询参数正常填写即可 });
常见注意事项
- 旧版本(CLI版本低于4.28.0)下的临时方案为手动拼接完整请求路径,该方案会丢失API网关自动注入的鉴权、日志上下文,升级到正式版本后不建议继续使用
- 路径参数必须通过
pathParameters字段传递,不要错误放到查询参数或请求体中,否则会触发API网关的路由匹配校验失败,返回403/404错误 - 如果是通过OpenAPI规范导入API配置,只要规范中定义了带路径参数的操作,Amplify会自动完成参数映射,无需额外手动配置
内容的提问来源于stack exchange,提问作者Nicolas Ould Bouamama
相关产品推荐
相关产品推荐

