Стандартный способ определения правил использования API, возможно для динамического интерфейса - PullRequest
Новая
       13

Стандартный способ определения правил использования API, возможно для динамического интерфейса

0 голосов
/ 12 июня 2019

Есть ли общий способ определения правил использования API в самом API?

Например, API для бронирования ремонта крыши может потребоваться узнать, находится ли крыша ниже 3 метров, от 3 до 10 метров или более 10 метров. Но вы хотите, чтобы пользовательский интерфейс знал, что в настоящее время, если потребитель выберет «более 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."
  },
...