Атрибуты ресурсов apiary.io в виде точек. Существует ли конкретное соглашение, чтобы показать, какой тип данных эти атрибуты или соответствуют форматам данных?Каково соглашение для указания типов данных атрибутов в методе apiary.io?
ответ
В настоящее время нет соглашения для обсуждения атрибутов ресурса в API Blueprint. Близится запланированоMessage-body Attributes Description.
Но я чувствую, что было бы реальным решением является то, что концепция будущего API Blueprint - Resource Blueprint предлагает под семантического определения данных (ресурса). См. example resource blueprint.
Таким образом, хотя ни один из предыдущих не будет реализован, если вы ищете конвенции, я предложил бы рассмотреть один, как это предлагается в Blueprint ресурсов, например:
# Resource [/resource]
## Attributes
+ ip (string) ... ipv4 or ipv6 address associated with the resource
+ some-other-attribute (number, optional, `42`) ... a number of something
Спасибо, вы ответили на мой конкретный вопрос о стандарте/синтаксисе для моделирования типов данных атрибутов ресурса. Вы также ответили на вопросы, которые я не задавал, как моделировать государственные машины. Это, или я должен сказать, будет ужасно. Я рад видеть моделирование государственных машин. Я с нетерпением жду добавления дополнительной поддержки ресурса. Надеюсь, это скоро. – jevonearth
Вы со ссылкой на ресурс атрибуты - свойства ресурса или к конкретным атрибутам HTTP-сообщения (запроса/ответа)? – Zdenek
Я ищу, чтобы указать тип данных для каждого атрибута ресурса. Я также хотел бы предложить дополнительную информацию. Представьте себе атрибут «ip», который будет строкой, я также хотел бы указать, что это может быть адрес ipv4 или ipv6. Все это легко сделать в уценке, но мне интересно, существует ли соглашение, которое, возможно, добавит больше значения. Thnx. – jevonearth