在其站点的developer部分,MailChimp链接到描述其API的JSON模式。
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,但是它有“schema”和“targetSchema”字段引用其他JSON文件,而不使用JSON指针(https://spacetelescope.github.io/understanding-json-schema/structuring.html)。它还混合了一些HATEOAS的概念吗?
有什么工具可以让我不用手动调节MailChimp发布的所有JSON模式文件就可以使用这个JSON模式?
我的目标是最终为MailChimp的API创建一个Swagger2.0 (OpenAPI)定义。我有一个将JSON超级模式转换为Swagger2.0的工具。
发布于 2016-12-15 02:38:19
我接受了TooMuchPete的建议。
以下是MailChimp所说的话:
嗨乔丹, 谢谢你伸出援手。目前,我们使用这两种规范的混合。我们目前使用Swagger来为文档目的布局我们的模式,但是,我们将JSON模式用于其他函数,例如请求验证和API的其他部分。尽管如此,我们目前正在将这些职能移交给Swagger。尽管如此,下面是一个URL,它应该有助于使用我们的模式。 http://api.mailchimp.com/schema/3.0/Swagger.json
发布于 2016-12-10 17:42:30
我的理解是,MailChimp正在从JSON过渡到Swagger,因为这是它们生成文档的方式。您可能需要与他们的API服务台联系,看看是否可以公开使用该工具。
https://stackoverflow.com/questions/41070496
复制相似问题