为图书管理系统设计一个宁静的API(JSON Data,Spring MVC,Restful API)

时间:2013-09-25 02:58:46

标签: json spring rest post get

我是我在下面发布的所有内容的新手。我知道基本的Java编程。我过去使用过基础级肥皂。但是在这里我不明白这个Rest API是什么?它看起来怎么样?它发展后会带来什么?

我将不胜感激,可以指导我从哪里开始,创建什么类,在开始这项工作之前要了解哪些技术。我真的想学习这些东西。

我想使用Spring MVC构建RESTful API

我必须为图书馆建立图书管理系统。

1)它必须支持API的JSON数据格式。

2)应用程序名称应为“库”,以便所有端点都以

开头

3)http://x.x.x.x:8080/library

4)应用服务器必须在端口8080上运行。

1)资源模型

书籍--->评测 | | 著者

2)资源详情

图书

--- ISBN(密钥)#您将生成此密钥。

---标题(必填项)

---出版日期(必填项)

---语言(可选字段)

---页数(可选字段)

---状态{可用,签出,在队列中或丢失}#默认为'可用'

作者

--- ID(Key)#您将生成此密钥。

---姓名(必填项)

评论

--- ID(Key)#您将生成此密钥。

---评级(1-5星)(必填项)

---评论(必填项)

* 要构建的API * 1)根API -

○资源:GET - /(E.g http://x.y.z:8080/library/v1/

○描述:这是客户端可以启动系统工作流程的地方。返回启动工作流的链接列表,即创建新书。

预期回应:

HTTP Code: 200
{
“links” : [
{ “rel”: “create-book”, “herf”: “/books”, “method”: “POST” }
]
}

2)创建Book API

○资源:POST - / books

○描述:将新书与作者信息一起添加到库中。

示例请求:请求正文中包含以下有效内容的POST / books。

{
"title" : "Programming Amazon EC2",
"publication-date" : "2/11/2011",
"language" : "eng",
"num-pages": 185,
"status" : "available",
"authors" : [
{ "name" : "Jurg Vliet" },
{"name" : "FlaviaPagenelli"} ]
}

预期回应:

HTTP Code: 201

{
“links” : [
{ “rel”: “view-book”, “herf”: “/books/1”, “method”: “GET” },
{ “rel”: “update-book”, “herf”: “/books/1”, “method”: “PUT” },
{ “rel”: “delete-book”, “herf”: “/books/1”, “method”: “DELETE” },
{ “rel”: “create-review”, “herf”: “/books/1/reviews”, “method”: “POST” }
]
}

同样还有更多的API ......

提前感谢,感谢任何帮助。

1 个答案:

答案 0 :(得分:6)

查看http://spring.io/guides/gs/rest-service/

您可以在应用程序服务器上配置端口号(默认情况下,jboss配置为8080)。并在其中部署“library.war”。这样你就可以直接使用ttp://x.x.x.x:8080 / library

http://www.mkyong.com/spring-mvc/spring-3-mvc-and-json-example/将帮助您准备JSON回复。