Table of Contents
回复内容:
Home Backend Development PHP Tutorial RESTful多个资源关联时,应如何返回数据?

RESTful多个资源关联时,应如何返回数据?

Jun 06, 2016 pm 08:33 PM
java php python restful ruby

比如想获取XX公司XX部门XX用户的地址,设计的URL可能会是这样:

<code>GET: /companies/${id}/departments/${id}/users/${id}/address
</code>
Copy after login
Copy after login

json方式的返回结果应该如何组织呢?

一些人不清楚问的是什么意思,我再多描述些。

比如返回结果可以是:

<code>{
    "code": 200,
    "message": "xxx",
    "results": [
        {
            "xxx": "xxx"    // address的信息列表
        }
    ]
}
</code>
Copy after login
Copy after login

因为是多个资源进行关联,有些对于results也可能会这样返回:

<code>{
     "company": {
          "xxx": "xxx",    // company的信息列表
          "department": {
              "xxx": "xxx"    // department的信息列表
              "address": {    // 最后是address的信息列表
                  "xxx": "xxx"
              }
          }
     }
}
</code>
Copy after login
Copy after login

还有使用Hypermedia API的设计方式(HATEOAS),也就是说对于company,他不返回${id}对应的信息,而是返回一个链接。(对于HATEOAS,我也是比较迷糊的状态)

所以...对于多个资源关联查询,结果应该以何种json结构返回呢?

回复内容:

比如想获取XX公司XX部门XX用户的地址,设计的URL可能会是这样:

<code>GET: /companies/${id}/departments/${id}/users/${id}/address
</code>
Copy after login
Copy after login

json方式的返回结果应该如何组织呢?

一些人不清楚问的是什么意思,我再多描述些。

比如返回结果可以是:

<code>{
    "code": 200,
    "message": "xxx",
    "results": [
        {
            "xxx": "xxx"    // address的信息列表
        }
    ]
}
</code>
Copy after login
Copy after login

因为是多个资源进行关联,有些对于results也可能会这样返回:

<code>{
     "company": {
          "xxx": "xxx",    // company的信息列表
          "department": {
              "xxx": "xxx"    // department的信息列表
              "address": {    // 最后是address的信息列表
                  "xxx": "xxx"
              }
          }
     }
}
</code>
Copy after login
Copy after login

还有使用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>
Copy after login

根据你的 URI,各对象的关系如下图(把地址做了展开):
RESTful多个资源关联时,应如何返回数据?

从「资源」的角度来看,URI 已经很清晰,取「某人的地址」,那么直接返回即可(假设 MediaType 是 JSON):

<code>{
    "province" : "上海市",
    "city" : "上海市",
    "district" : "黄浦区",
    "address" : "日月光广场"
}
</code>
Copy after login

目前我的设计原则如下(可能还不够规范,持续改进中):

  • 使用 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>
Copy after login
Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
2 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island Adventure: How To Get Giant Seeds
1 months ago By 尊渡假赌尊渡假赌尊渡假赌
Two Point Museum: All Exhibits And Where To Find Them
1 months ago By 尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

Explain late static binding in PHP (static::). Explain late static binding in PHP (static::). Apr 03, 2025 am 12:04 AM

Static binding (static::) implements late static binding (LSB) in PHP, allowing calling classes to be referenced in static contexts rather than defining classes. 1) The parsing process is performed at runtime, 2) Look up the call class in the inheritance relationship, 3) It may bring performance overhead.

What are PHP magic methods (__construct, __destruct, __call, __get, __set, etc.) and provide use cases? What are PHP magic methods (__construct, __destruct, __call, __get, __set, etc.) and provide use cases? Apr 03, 2025 am 12:03 AM

What are the magic methods of PHP? PHP's magic methods include: 1.\_\_construct, used to initialize objects; 2.\_\_destruct, used to clean up resources; 3.\_\_call, handle non-existent method calls; 4.\_\_get, implement dynamic attribute access; 5.\_\_set, implement dynamic attribute settings. These methods are automatically called in certain situations, improving code flexibility and efficiency.

Is the conversion speed fast when converting XML to PDF on mobile phone? Is the conversion speed fast when converting XML to PDF on mobile phone? Apr 02, 2025 pm 10:09 PM

The speed of mobile XML to PDF depends on the following factors: the complexity of XML structure. Mobile hardware configuration conversion method (library, algorithm) code quality optimization methods (select efficient libraries, optimize algorithms, cache data, and utilize multi-threading). Overall, there is no absolute answer and it needs to be optimized according to the specific situation.

Is there any mobile app that can convert XML into PDF? Is there any mobile app that can convert XML into PDF? Apr 02, 2025 pm 08:54 PM

An application that converts XML directly to PDF cannot be found because they are two fundamentally different formats. XML is used to store data, while PDF is used to display documents. To complete the transformation, you can use programming languages ​​and libraries such as Python and ReportLab to parse XML data and generate PDF documents.

How to convert XML files to PDF on your phone? How to convert XML files to PDF on your phone? Apr 02, 2025 pm 10:12 PM

It is impossible to complete XML to PDF conversion directly on your phone with a single application. It is necessary to use cloud services, which can be achieved through two steps: 1. Convert XML to PDF in the cloud, 2. Access or download the converted PDF file on the mobile phone.

What is the function of C language sum? What is the function of C language sum? Apr 03, 2025 pm 02:21 PM

There is no built-in sum function in C language, so it needs to be written by yourself. Sum can be achieved by traversing the array and accumulating elements: Loop version: Sum is calculated using for loop and array length. Pointer version: Use pointers to point to array elements, and efficient summing is achieved through self-increment pointers. Dynamically allocate array version: Dynamically allocate arrays and manage memory yourself, ensuring that allocated memory is freed to prevent memory leaks.

How to open xml format How to open xml format Apr 02, 2025 pm 09:00 PM

Use most text editors to open XML files; if you need a more intuitive tree display, you can use an XML editor, such as Oxygen XML Editor or XMLSpy; if you process XML data in a program, you need to use a programming language (such as Python) and XML libraries (such as xml.etree.ElementTree) to parse.

How to convert xml into pictures How to convert xml into pictures Apr 03, 2025 am 07:39 AM

XML can be converted to images by using an XSLT converter or image library. XSLT Converter: Use an XSLT processor and stylesheet to convert XML to images. Image Library: Use libraries such as PIL or ImageMagick to create images from XML data, such as drawing shapes and text.

See all articles