json - 为图书管理系统设计一个restful API (JSON Data, Spring MVC, Restful API)

Question

我对我在下面发布的所有内容都很陌生。我知道基本的 Java 编程。我过去使用过基本级别的肥皂。但是这里我不明白这个Rest API是什么？它看起来如何？它在开发时提供了什么？

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

我想使用 Spring MVC 构建一个 RESTful API

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

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

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

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

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

1)资源模型

书籍 ---> 评论
|
|
作者

2) 资源详情

图书

---ISBN (Key) # 您将生成此 key 。

---标题(必填字段)

---出版日期(必填字段)

---语言(可选字段)

---页数(可选字段)

---状态{可用、 checkout 、排队或丢失}#默认为“可用”

作者

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

---姓名(必填字段)

评论

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

---评级(1-5 星)(必填字段)

---评论(必填字段)

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

○ 资源:GET -/(例如 http://x.y.z:8080/library/v1/)

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

预期回应:

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

2)创建图书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 ......

提前致谢，任何帮助表示赞赏。

Answer 1

看看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 响应。