Question

在API本身中是否有定义API使用规则的通用方法？

例如，用于预订屋顶维修的API可能需要知道屋顶是否低于3米，低于3米至10米或超过10米。但是您希望UI知道当前如果消费者选择“超过10米”，则该请求将被拒绝，因此他们知道以适当的方式结束客户的旅程，而不是让客户先尝试解决其他问题提交API。

类似这样的东西：

"roofHeight": {
    "type": "enum",
    "acceptedValues": {
        "LOW": "Under 3 meters",
        "MEDIUM": "Between 3 and 10 meters"
    },
    "rejectedValues": {
        "HIGH": "Over 10 meters"
    },
    "description": "Height of roof."
  },

Answer 1

您也许正在谈论API文档和合同。您可以参考swagger API文档进行此活动。 https://swagger.io/docs/

定义用于动态UI的API使用规则的标准方法

1 个答案: