RESTful多个资源关联时,应如何返回数据?
比如想获取XX公司XX部门XX用户的地址,设计的URL可能会是这样:
<code>GET: /companies/${id}/departments/${id}/users/${id}/address </code>
json方式的返回结果应该如何组织呢?
一些人不清楚问的是什么意思,我再多描述些。
比如返回结果可以是:
<code>{ "code": 200, "message": "xxx", "results": [ { "xxx": "xxx" // address的信息列表 } ] } </code>
因为是多个资源进行关联,有些对于results也可能会这样返回:
<code>{ "company": { "xxx": "xxx", // company的信息列表 "department": { "xxx": "xxx" // department的信息列表 "address": { // 最后是address的信息列表 "xxx": "xxx" } } } } </code>
还有使用Hypermedia API的设计方式(HATEOAS),也就是说对于company,他不返回${id}对应的信息,而是返回一个链接。(对于HATEOAS,我也是比较迷糊的状态)
所以...对于多个资源关联查询,结果应该以何种json结构返回呢?
回复内容:
比如想获取XX公司XX部门XX用户的地址,设计的URL可能会是这样:
<code>GET: /companies/${id}/departments/${id}/users/${id}/address </code>
json方式的返回结果应该如何组织呢?
一些人不清楚问的是什么意思,我再多描述些。
比如返回结果可以是:
<code>{ "code": 200, "message": "xxx", "results": [ { "xxx": "xxx" // address的信息列表 } ] } </code>
因为是多个资源进行关联,有些对于results也可能会这样返回:
<code>{ "company": { "xxx": "xxx", // company的信息列表 "department": { "xxx": "xxx" // department的信息列表 "address": { // 最后是address的信息列表 "xxx": "xxx" } } } } </code>
还有使用Hypermedia API的设计方式(HATEOAS),也就是说对于company,他不返回${id}对应的信息,而是返回一个链接。(对于HATEOAS,我也是比较迷糊的状态)
所以...对于多个资源关联查询,结果应该以何种json结构返回呢?
ls为毛会-1,说的有啥问题没
你的最终目的是get地址,响应把获取的地址返回给客户端不就可以了吗,怎么会需要在意请求的url?
不是很清楚在问什么
返回的json格式吗?
前端需要什么数据就返回什么数据呗
如果只需要用到地址
就直接返回{"address": address}
如果前端跟后端有约定返回格式,就按格式返回就好了
例如
<code>json</code><code>{ "status": STATUS, //可能为请求状态码,表示请求成功与否 "data": { "address": address,//主要获取的信息 "other": other//其他可能需要的信息 } } </code>
根据你的 URI,各对象的关系如下图(把地址做了展开):
从「资源」的角度来看,URI 已经很清晰,取「某人的地址」,那么直接返回即可(假设 MediaType 是 JSON):
<code>{ "province" : "上海市", "city" : "上海市", "district" : "黄浦区", "address" : "日月光广场" } </code>
目前我的设计原则如下(可能还不够规范,持续改进中):
- 使用 HTTP Status Code 返回成功失败;
- 如果 Status Code 不是 200/201 再返回 Error Object,此时再增加自定义错误信息,有对应的 Code 和 Message;
- 可以考虑在 Address 增加 Link,一个是是 Address URI,另一个是 User URI;
关于 HATEOAS 还在理解中,不敢乱说 :P
开发中的产品基于 REST 架构,也在读下面的几本书,方便的话多交流:
- RESTful Web Services Cookbook 中文版 ,针对使用 REST 过程中的一些疑惑,作者几乎都有了思考和答案;
- REST 实战 ,加强理论知识用的,因为李锟的推荐;
- RESTful Web APIs 中文版 刚刚同入手,正要拜读;
<code>'address' </code>

Hot AI Tools

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Undress AI Tool
Undress images for free

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Hot Topics

PHP is mainly procedural programming, but also supports object-oriented programming (OOP); Python supports a variety of paradigms, including OOP, functional and procedural programming. PHP is suitable for web development, and Python is suitable for a variety of applications such as data analysis and machine learning.

Python is more suitable for beginners, with a smooth learning curve and concise syntax; JavaScript is suitable for front-end development, with a steep learning curve and flexible syntax. 1. Python syntax is intuitive and suitable for data science and back-end development. 2. JavaScript is flexible and widely used in front-end and server-side programming.

The core benefits of PHP include ease of learning, strong web development support, rich libraries and frameworks, high performance and scalability, cross-platform compatibility, and cost-effectiveness. 1) Easy to learn and use, suitable for beginners; 2) Good integration with web servers and supports multiple databases; 3) Have powerful frameworks such as Laravel; 4) High performance can be achieved through optimization; 5) Support multiple operating systems; 6) Open source to reduce development costs.

PHP is suitable for web development and rapid prototyping, and Python is suitable for data science and machine learning. 1.PHP is used for dynamic web development, with simple syntax and suitable for rapid development. 2. Python has concise syntax, is suitable for multiple fields, and has a strong library ecosystem.

PHP is a server-side scripting language used for dynamic web development and server-side applications. 1.PHP is an interpreted language that does not require compilation and is suitable for rapid development. 2. PHP code is embedded in HTML, making it easy to develop web pages. 3. PHP processes server-side logic, generates HTML output, and supports user interaction and data processing. 4. PHP can interact with the database, process form submission, and execute server-side tasks.

PHP is suitable for web development and content management systems, and Python is suitable for data science, machine learning and automation scripts. 1.PHP performs well in building fast and scalable websites and applications and is commonly used in CMS such as WordPress. 2. Python has performed outstandingly in the fields of data science and machine learning, with rich libraries such as NumPy and TensorFlow.

PHP has shaped the network over the past few decades and will continue to play an important role in web development. 1) PHP originated in 1994 and has become the first choice for developers due to its ease of use and seamless integration with MySQL. 2) Its core functions include generating dynamic content and integrating with the database, allowing the website to be updated in real time and displayed in personalized manner. 3) The wide application and ecosystem of PHP have driven its long-term impact, but it also faces version updates and security challenges. 4) Performance improvements in recent years, such as the release of PHP7, enable it to compete with modern languages. 5) In the future, PHP needs to deal with new challenges such as containerization and microservices, but its flexibility and active community make it adaptable.

PHP originated in 1994 and was developed by RasmusLerdorf. It was originally used to track website visitors and gradually evolved into a server-side scripting language and was widely used in web development. Python was developed by Guidovan Rossum in the late 1980s and was first released in 1991. It emphasizes code readability and simplicity, and is suitable for scientific computing, data analysis and other fields.
