WADL

时间:2017-11-02 13:04:19

标签: json jsonschema wadl

假设我们有一个通过WADL文件描述的RESTful API。请求正文和响应正文(如果有)的内容类型为application/json。我想知道是否有一些标准方法来为请求和响应指定模式。用JSON Schema描述JSON主体是很自然的。我试图找到一些信息,这些是我的结论:

  • WADL文件经常不包含JSON主体的架构。它们只包含这个简单的元素:<representation mediaType="application/json"/>
  • 根据WADL规范(https://www.w3.org/Submission/wadl/),没有标准方法将JSON Schema包含在WADL文件中。
  • WADL文件可以包含XML Schema。这对于XML响应来说很好。如果我想在XML和JSON之间进行一些映射,我可以通过XML Schema描述JSON的结构。但是,没有单一的标准映射用于此目的。

我的结论是,没有标准方法来描述WADL文件中JSON请求/响应的模式。甚至没有通常的(事实上的标准)解决方法来完成这项任务。

我的结论是否正确?

感谢。

修改

我想说JSON是RESTful API最常用的格式,请求和响应的模式对于描述API至关重要。因此,使用WADL文件描述RESTful API的每个人都需要内联或以某种方式引用JSON模式。应该有一种标准的方法来做到这一点,因为它是一个非常标准的要求。此外,使用WADL文件(如SoapUI)的工具应该理解这种“标准方式”,以便这些工具可以例如使用。生成包含JSON主体的示例请求。

然而,在我看来,没有这样的标准方式。我只想问我是否忽视了一些事情。

我知道我可以通过Swagger描述符以接近JSON Schema的方式描述JSON请求/响应主体。但是,我被迫在我的项目中使用WADL。

0 个答案:

没有答案