如何通过 API 使用严格模式
严格模式是一项 API 功能,可确保在创建或更新配置文件时明确提供每个必填字段。这有助于避免因缺失值或默认值而导致的错误。
严格模式 vs. 非严格模式
严格模式
- 要求您指定 API 创建或更新配置文件所需的每个字段
- 如果缺少任何内容,您将收到一条错误消息,其中列出了您需要填写的具体字段
- 对于需要对数据进行完全控制的用户,或者在自动化场景中需要所有参数都明确定义的情况,这一功能非常有用
非严格模式
- 允许将可选字段留空:如果您不指定,系统将自动应用默认值
- 这是大多数 API 用户的默认设置,通过自动填写缺失的详细信息使事情变得简单
为什么要使用严格模式?
严格模式可确保您提供的数据完整准确,对于进行自动化操作的用户或需要严格校验以满足合规要求的场景尤其有用。若未启用严格模式,缺失关键字段可能会导致不可预测或意外的结果。
以下是你可能需要启用严格模式的情况:
- 您需要完全控制您的配置文件中的所有参数
- 您需要对每个字段进行精确校验,特别是在涉及自动化流程或合规性要求时。
- 您更倾向于在出现问题时看到清晰且详细的错误信息。
- 您需要向后兼容:不再需要它?那就关掉它吧!
如何使用严格模式
要启用严格模式,请在请求中添加X-Strict-Mode: true
标头。如果您未指定此标头, API将默认使用非严格模式。
💡 如果在使用严格模式时遗漏了一个字段会发生什么?
系统会返回详细的错误信息,告知您哪些字段缺失。这比针对每个缺失字段单独报错更有帮助。