带有表单和链接的JSON超媒体Api

Question

"links": [ 
{"rel": "self", "href":"http://example.org/entity/1"},
{"rel": "friends", "href":"http://example.org/entity/1/friends"}] 

"forms" : [
{"rel" : "new client", "action" : "/clients", "method": "post", 
"fields" : ["name":"string", "zipcode":"int", "signedup":"date", "state": ["Alabama",...]...]}]

顺便说一句，真的很好的谈话！

所有的输入都很感激！

Answer 1

我已经研究了这个主题一段时间，但我不确定ppl使用哪些可能的解决方案，哪些不使用。只有几个例子...所以我需要一些专家的审查...（我的示例将主要使用HAL+JSON。）

1.）

我有一种感觉，链接关系应该只得到，因为在HTML中，它们是用来包括样式表之类的东西的。我想其他ppl也有同样的感觉，因为IANA有一个edit-form和一个create-form链接关系。

{
    "_links": {
        "edit-form": {
            "href": "http://example.com/users/1?form=edit",
            "type": "text/html",
            "title": "Edit user"
        }
    }
}

>

如果我们发送数据，那么我们可以使用类型来描述请求正文而不是响应正文。OFC.在这种情况下，不应该有一个响应机构，否则这个解决方案会令人困惑。

    {
        "_links": {
            "curies": [
                {
                    "name": "my",
                    "href": "http://example.com/rels/{rel}",
                    "templated": true
                }
            ],
            "my:edit": {
                "href": "http://example.com/users/1",
                "type": "application/vnd.example.user+json",
                "title": "Edit user"
            }
        }
    }

因此，在本例中，客户机将知道my:edit意味着这是一个编辑表单，并且通过检查MIME类型，它将知道要显示的表单类型。

将自定义链接关系用于相同目的的替代解决方案：

    {
        "_links": {
            "curies": [
                {
                    "name": "my",
                    "href": "http://example.com/rels/{rel}",
                    "templated": true
                }
            ],
            "my:edit-user": {
                "href": "http://example.com/users/1",
                "type": "application/json",
                "title": "Edit user"
            }
        }
    }

    {
        "_links": {
            "curies": [
                {
                    "name": "my",
                    "href": "http://example.com/rels/{rel}",
                    "templated": true
                }
            ],
            "my:edit": {
                "href": "http://example.com/users/1",
                "type": "application/json",
                "title": "Edit user",
                "profile": "http://example.com/profiles/user"
            }
        }
    }

>

例如，dougrain-forms这样做：

    {
        "_forms": {
            "edit": {
                "href": "http://example.com/users/1",
                "headers": {
                    "content-type": "application/json"
                },
                "title": "Edit user",
                "method": "PUT",
                "schema": {
                    "required": [
                        "name"
                    ],
                    "type": "object",
                    "properties": {
                        "name": {
                            "type": "string"
                        }
                    },
                    "title": "user properties"
                }
            }
        }
    }

但是，只要我们没有关于HAL和HAL表单的标准，您可以使用任何替代方法，例如，我宁愿使用类似于猫鼬模式的解决方案：

    {
        "name": "John",
        "_links": {
            "curies": [
                {
                    "name": "my",
                    "href": "http://example.com/rels/{rel}",
                    "templated": true
                }
            ],
            "my:edit": {
                "href": "http://example.com/users/1",
                "type": "application/json",
                "title": "Edit user",
                "method": "PUT",
                "_embedded": {
                    "schema": {
                        "name": "String"
                    }
                }
            }
        }
    }

4.）

{
    "@context": [
        "http://www.w3.org/ns/hydra/core",
        "https://example.com/docs#"
    ],
    "@id": "https://example.com/users/1",
    "name": "John",
    "operation": {
        "@type": "ReplaceResourceOperation",
        "title": "Edit user",
        "method": "PUT",
        "expects": {
            "@id": "https://example.com/docs#User",
            "supportedProperty": {
                "@type": "SupportedProperty",
                "title": "name",
                "property": "https://example.com/docs#User.name",
                "range": "http://www.w3.org/2001/XMLSchema#string",
                "required": true
            }
        }
    }
}