blocks|key|430632|text|看看Collection%2BJSON，HAL，和/或警报器。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|430633|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

Check out Collection+JSON, HAL, and/or Siren.

blocks|key|430670|text|据我所知，目前还没有一种公开指定的、通用的表单JSON格式。如果需要，您可以自由定义一个，并发布规范。作为个人偏好，我建议以HAL为基础。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|430671|如果您确实决定编写自己的邮件列表，请创建一个邮件列表，并邀请其他人参与。如果你不这样做，你就有可能对它进行过于严密的裁剪，只满足你自己的需求，并意外地忽略了一些阻止它广泛应用的需求。|430672|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|F|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|G|8|@]|9|@]|A|$]]|$1|D|3|-4|5|6|7|H|8|@]|9|@]|A|$]]]|E|$]]

There currently isn't a publicly specced, general purpose JSON format with forms, as far as I am aware. You're free to define one if you need it and publish the specifcations. As a personal preference, I recommend basing it upon HAL.

If you do decide to write one of your own, please create a mailing list and invite others to participate. If you don't, you'd be in danger of tailoring it too closely to meet just your own needs and accidentally overlooking some requirement that prevents it from being widely applicable.

blocks|key|212291|text|JSON+Schema标准(特别是“超模式”)明确支持这一点。您引用了一个JSON+(Hyper-)Schema+(使用HTTP头)，该模式定义了如何将数据解释为超文本的规则。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|212292|构建链接的信息可以在任何地方。超模式记录了如何从数据组装链接URI(它可以是一个模板)，它们还指定了HTTP方法、编码类型等。|212293|要获得表单功能:您可以为与请求一起提交的数据指定一个完整的模式。必需/可选属性、数组长度约束等等。|212294|作为演示，下面是一个理解超模式并为链接提供适当形式的JavaScript库演练的一部分：jsonary.com。|212295|entityMap|0|LINK|mutability|MUTABLE|url|http://json-schema.org/|1|http://jsonary.com/feature-tour/stage3/^0|0|B|0|0|0|0|18|B|1|0^^$0|@$1|2|3|4|5|6|7|T|8|@]|9|@$A|U|B|V|1|W]]|C|$]]|$1|D|3|E|5|6|7|X|8|@]|9|@]|C|$]]|$1|F|3|G|5|6|7|Y|8|@]|9|@]|C|$]]|$1|H|3|I|5|6|7|Z|8|@]|9|@$A|10|B|11|1|12]]|C|$]]|$1|J|3|-4|5|6|7|13|8|@]|9|@]|C|$]]]|K|$L|$5|M|N|O|C|$P|Q]]|R|$5|M|N|O|C|$P|S]]]]

The <a href="http://json-schema.org/" rel="noreferrer">JSON Schema</a> standard (particularly "hyper-schemas") definitely allows this. You reference a JSON (Hyper-)Schema (using HTTP headers) and the schema defines rules on how to interpret your data as hyper-text.

The information for constructing your links can be anywhere. The hyper-schema documents how to assemble link URIs from the data (it can be a template), and they also specify HTTP method, encoding type, and so on.

To get form functionality: you can specify a full schema for the data to be submitted along with the request. Required/optional properties, array length constraints, whatever.

As a demo, here's part of a walkthrough for a JavaScript library that understands hyper-schemas and can present an appropriate form for links: <a href="http://jsonary.com/feature-tour/stage3/" rel="noreferrer">jsonary.com</a>.

blocks|key|430735|text|我一直在开发一个API，使用JSON+Hyper+Schema。您可以浏览周围，甚至注册、登录和执行一些操作。在这里查看：http://api.psprt.com|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|430736|编辑请参阅此处的最新内容:+www.passportedu.com+https://github.com/bpanahij/HypermediaServer+https://github.com/bpanahij/client-schema.json|430737|我还开源了API代码：https://github.com/bpanahij/passportedu_schema。|430738|请随时查看、借用和评论。|430739|JSON+Hyper+Schema+(另请参阅JSON-Schema)有一种通过属性成员指定表单的方法：|430740|{
"id":+"/api/v1",
"$schema":+"http://json-schema.org/draft-04/schema#",
"title":+"PassportEDU+API",
"name":+"PassportEDU+API",
"type":+"object",
"description":+"Bringing+global+students+together+with+global+schools.",
"links":+[
+++{
++++++"title":+"Log+In",
++++++"rel":+"authenticate",
++++++"href":+"/api/v1/authenticate",
++++++"method":+"POST",
++++++"properties":+{
++++++++"username":+{
++++++++++"title":+"Your+username",
++++++++++"description":+"Your+email+address+or+username",
++++++++++"type":+"string"
++++++++},
++++++++"password":+{
++++++++++"title":+"Your+password",
++++++++++"description":+"Your+password",
++++++++++"type":+"password"
++++++++}
++++++},
++++++"required":+["username",+"password"]
+++}
+++]
}|code-block|syntax|javascript|430741|entityMap|0|LINK|mutability|MUTABLE|url|http://api.psprt.com/|1|https://github.com/bpanahij/HypermediaServer|2|https://github.com/bpanahij/client-schema.json|3|https://github.com/bpanahij/passportedu_schema|4|http://json-schema.org/latest/json-schema-hypermedia.html|5|http://json-schema.org/^0|1P|K|0|0|Y|18|1|27|1A|2|0|B|1A|3|0|0|0|H|4|N|B|5|0|0^^$0|@$1|2|3|4|5|6|7|18|8|@]|9|@$A|19|B|1A|1|1B]]|C|$]]|$1|D|3|E|5|6|7|1C|8|@]|9|@$A|1D|B|1E|1|1F]|$A|1G|B|1H|1|1I]]|C|$]]|$1|F|3|G|5|6|7|1J|8|@]|9|@$A|1K|B|1L|1|1M]]|C|$]]|$1|H|3|I|5|6|7|1N|8|@]|9|@]|C|$]]|$1|J|3|K|5|6|7|1O|8|@]|9|@$A|1P|B|1Q|1|1R]|$A|1S|B|1T|1|1U]]|C|$]]|$1|L|3|M|5|N|7|1V|8|@]|9|@]|C|$O|P]]|$1|Q|3|-4|5|6|7|1W|8|@]|9|@]|C|$]]]|R|$S|$5|T|U|V|C|$W|X]]|Y|$5|T|U|V|C|$W|Z]]|10|$5|T|U|V|C|$W|11]]|12|$5|T|U|V|C|$W|13]]|14|$5|T|U|V|C|$W|15]]|16|$5|T|U|V|C|$W|17]]]]

I have been working on an API, using JSON Hyper Schema.
You can browse aroun, and even register, login and do some actions. Check it out, here:
<a href="http://api.psprt.com" rel="nofollow">http://api.psprt.com</a>

[EDIT] See my latest stuff here:
www.passportedu.com
<a href="https://github.com/bpanahij/HypermediaServer" rel="nofollow">https://github.com/bpanahij/HypermediaServer</a>
<a href="https://github.com/bpanahij/client-schema.json" rel="nofollow">https://github.com/bpanahij/client-schema.json</a>

I also open sourced the API code:
<a href="https://github.com/bpanahij/passportedu_schema" rel="nofollow">https://github.com/bpanahij/passportedu_schema</a>

Feel free to take a look, borrow, and comment.

<a href="http://json-schema.org/latest/json-schema-hypermedia.html" rel="nofollow">JSON Hyper Schema</a> (See Also <a href="http://json-schema.org/" rel="nofollow">JSON-Schema</a>) has a way to specify forms, 
through the properties member:

<pre><code>{
"id": "/api/v1",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PassportEDU API",
"name": "PassportEDU API",
"type": "object",
"description": "Bringing global students together with global schools.",
"links": [
 {
 "title": "Log In",
 "rel": "authenticate",
 "href": "/api/v1/authenticate",
 "method": "POST",
 "properties": {
 "username": {
 "title": "Your username",
 "description": "Your email address or username",
 "type": "string"
 },
 "password": {
 "title": "Your password",
 "description": "Your password",
 "type": "password"
 }
 },
 "required": ["username", "password"]
 }
 ]
}
</code></pre>

I am in the early stages of planning a REST api, and I would like for it to adhere to the HATEOAS constraint of REST. But I would also like to provide a JSON format. So my question is if there are conventions out there to represent links and forms in JSON.

I have found examples of links, and it looks like this is a pretty common way of representing links:

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

Representing forms on the other hand, is not something that I have seen much of. I was thinking that perhaps somebody had sat down and thought up something along these lines, but considered all the caveats:

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

The inspiration for this comes from looking at this video, where Jon Moore suggests that JSON is not a good format for a hypermedia api:

<a href="http://oredev.org/2010/sessions/hypermedia-apis" rel="noreferrer">http://oredev.org/2010/sessions/hypermedia-apis</a>

A really good talk by the way!

All input is appreciated!

JSON Hypermedia Api with forms and links

JSON

我正处于规划REST api的早期阶段，我希望它遵守REST的HATEOAS约束。但我也想提供一种JSON格式。所以我的问题是，在JSON中是否有表示链接和表单的约定。我已经找到了链接的例子，看起来这是一种非常常见的表示链接的方式："links": [ {"rel": "self", "href":"http://ex...

问具有表单和链接的JSON Hypermedia Api
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问具有表单和链接的JSON Hypermedia ApiEN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问具有表单和链接的JSON Hypermedia Api
EN