Как я должен использовать схему JSON MailChimp для своего API?

Question

В части разработчика своего сайта MailChimp ссылается на схему JSON, описывающую ее API.

http://developer.mailchimp.com/documentation/mailchimp/guides/get-started-with-mailchimp-api-3/#json-schema

Я знаком с JSON-схем (Проект v4). Я понимаю их роль в проверке полезной нагрузки API, генерации документации и т. Д. Я также знаком с тем, как они контрастируют с схемами Swagger (OpenAPI) (которые в некотором роде похожи, но более полно документируют API).

Кажется, схема MailChimp представляет собой описание API в стиле Swagger, но на основе синтаксиса схемы JSON. Сначала он выглядит как JSON Hyper-Schema, но имеет поля «schema» и «targetSchema», ссылающиеся на другие файлы JSON без использования указателей JSON (https://spacetelescope.github.io/understanding-json-schema/structuring.html). Он также смешивается в некоторых концепциях HATEOAS?

Какой инструмент позволит мне использовать эту схему JSON без ручного согласования всех файлов схемы JSON, опубликованных MailChimp?

Моя цель в конечном счете создать определение API Swagger 2.0 (OpenAPI) API-интерфейса MailChimp. У меня есть инструмент для преобразования из JSON Hyper-Schemas в Swagger 2.0.

Answer 1

Я принял предложение TooMuchPete.

Вот что сказал MailChimp:

Привет Джордан,

Спасибо за сообщение. В настоящее время мы используем сочетание обоих этих спецификаций. В настоящее время мы используем Swagger для разработки нашей схемы для целей документирования, однако мы используем схемы JSON для других функций, таких как проверка запроса и другие части API. Тем не менее, мы в настоящее время переходим к этим функциям в Swagger. С учетом сказанного ниже приведен URL-адрес, который должен помочь в использовании наших схем.

http://api.mailchimp.com/schema/3.0/Swagger.json

Answer 2

Я понимаю, что MailChimp переходит от JSON Hyperschema к Swagger, так как именно так они создают свою документацию. Возможно, вам захочется обратиться в службу поддержки API и посмотреть, доступно ли показность.