2016-12-09 12 views
1

サイトの開発者の部分では、MailChimpはそのAPIを説明するJSONスキーマにリンクしています。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のスキーマは、SwaggerのようなAPIの説明ですが、JSONスキーマの構文に基づいています。最初は、JSON Hyper-Schemaのように見えますが、JSONポインタ(https://spacetelescope.github.io/understanding-json-schema/structuring.html)を使用せずに他のJSONファイルを参照する 'schema'フィールドと 'targetSchema'フィールドがあります。それはいくつかのHATEOASの概念を混在させていますか?

MailChimpによって公開されているすべてのJSONスキーマファイルを手動で調整せずにこのJSONスキーマを使用するツールはありますか?

私の目標は、最終的にMailChimpのAPIのSwagger 2.0(OpenAPI)定義を作成することです。 JSON Hyper-SchemasからSwagger 2.0に変換するためのツールがあります。

答えて

1

私はTooMuchPeteの提案を受けました。

こんにちはヨルダン、手を差し伸べるための

ありがとう:ここ

はMailChimpが言ったことです。現時点では、これらの仕様の両方を組み合わせて使用​​しています。現在Swaggerを使用してスキーマをドキュメント化していますが、リクエストの検証やAPIの他の部分など、他の機能にJSONスキーマを使用しています。つまり、現在、これらの機能をSwaggerに移行する段階にあります。以下では、スキーマの使用に役立つはずのURLを示します。

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

0

私の理解では、MailChimpはJSONハイパーシェーマからSwaggerに移行しているので、ドキュメントを生成する方法です。彼らのAPIヘルプデスクに連絡して、swaggerが公開されているかどうかを確認することもできます。

関連する問題