_link模型 - HATEOAS

时间:2017-03-11 13:16:10

标签: spring rest swagger spring-hateoas openapi

我被要求将HATEOAS作为我们的其余API的一部分来实现,这就是在Swagger规范中定义响应的方式

_links: 
[
 {
rel:    
 string
The relationship to the request e.g. self which contains the resource that was requested or {object name}, a link to a resource that is related to the requested resource
action: 
[
 {
    httpVerb:   
         string
        Allowed actions for this link based on the users permissions
        Enum:
        Array[4]
           0:"GET"
           1:"POST"
           2:"PUT"
           3:"DELETE"
   }
]
    href:   
      string
      A fully qualified URL to the resource.
  }
]

rel href 是有意义的,我可以找到这两个的很多例子,但我找不到任何动作的内容。它是标准的一部分吗?我真的应该寄回去吗?

我正在使用Spring hateoas库,但肯定不支持 actions 。任何有关这方面的指导都会很明显。

感谢。

1 个答案:

答案 0 :(得分:1)

有趣的是_links(带下划线)是一个HAL的东西,所以我不指望你遵循任何标准的规范。

我知道的一个标准包括actions SIREN,但它们与您示例中的action不同。

许多REST API甚至都不是RESTful,更不用说HATEOAS了。因此,遵循特定标准(或“标准”)的价值目前是值得商榷的。