search
HomeBackend DevelopmentPHP TutorialRESTful多个资源关联时,应如何返回数据?

比如想获取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,各对象的关系如下图(把地址做了展开):
RESTful多个资源关联时,应如何返回数据?

从「资源」的角度来看,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>
Statement
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
The Continued Use of PHP: Reasons for Its EnduranceThe Continued Use of PHP: Reasons for Its EnduranceApr 19, 2025 am 12:23 AM

What’s still popular is the ease of use, flexibility and a strong ecosystem. 1) Ease of use and simple syntax make it the first choice for beginners. 2) Closely integrated with web development, excellent interaction with HTTP requests and database. 3) The huge ecosystem provides a wealth of tools and libraries. 4) Active community and open source nature adapts them to new needs and technology trends.

PHP and Python: Exploring Their Similarities and DifferencesPHP and Python: Exploring Their Similarities and DifferencesApr 19, 2025 am 12:21 AM

PHP and Python are both high-level programming languages ​​that are widely used in web development, data processing and automation tasks. 1.PHP is often used to build dynamic websites and content management systems, while Python is often used to build web frameworks and data science. 2.PHP uses echo to output content, Python uses print. 3. Both support object-oriented programming, but the syntax and keywords are different. 4. PHP supports weak type conversion, while Python is more stringent. 5. PHP performance optimization includes using OPcache and asynchronous programming, while Python uses cProfile and asynchronous programming.

PHP and Python: Different Paradigms ExplainedPHP and Python: Different Paradigms ExplainedApr 18, 2025 am 12:26 AM

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.

PHP and Python: A Deep Dive into Their HistoryPHP and Python: A Deep Dive into Their HistoryApr 18, 2025 am 12:25 AM

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.

Choosing Between PHP and Python: A GuideChoosing Between PHP and Python: A GuideApr 18, 2025 am 12:24 AM

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 and Frameworks: Modernizing the LanguagePHP and Frameworks: Modernizing the LanguageApr 18, 2025 am 12:14 AM

PHP remains important in the modernization process because it supports a large number of websites and applications and adapts to development needs through frameworks. 1.PHP7 improves performance and introduces new features. 2. Modern frameworks such as Laravel, Symfony and CodeIgniter simplify development and improve code quality. 3. Performance optimization and best practices further improve application efficiency.

PHP's Impact: Web Development and BeyondPHP's Impact: Web Development and BeyondApr 18, 2025 am 12:10 AM

PHPhassignificantlyimpactedwebdevelopmentandextendsbeyondit.1)ItpowersmajorplatformslikeWordPressandexcelsindatabaseinteractions.2)PHP'sadaptabilityallowsittoscaleforlargeapplicationsusingframeworkslikeLaravel.3)Beyondweb,PHPisusedincommand-linescrip

How does PHP type hinting work, including scalar types, return types, union types, and nullable types?How does PHP type hinting work, including scalar types, return types, union types, and nullable types?Apr 17, 2025 am 12:25 AM

PHP type prompts to improve code quality and readability. 1) Scalar type tips: Since PHP7.0, basic data types are allowed to be specified in function parameters, such as int, float, etc. 2) Return type prompt: Ensure the consistency of the function return value type. 3) Union type prompt: Since PHP8.0, multiple types are allowed to be specified in function parameters or return values. 4) Nullable type prompt: Allows to include null values ​​and handle functions that may return null values.

See all articles

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

Video Face Swap

Video Face Swap

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

Hot Tools

SecLists

SecLists

SecLists is the ultimate security tester's companion. It is a collection of various types of lists that are frequently used during security assessments, all in one place. SecLists helps make security testing more efficient and productive by conveniently providing all the lists a security tester might need. List types include usernames, passwords, URLs, fuzzing payloads, sensitive data patterns, web shells, and more. The tester can simply pull this repository onto a new test machine and he will have access to every type of list he needs.

WebStorm Mac version

WebStorm Mac version

Useful JavaScript development tools

Atom editor mac version download

Atom editor mac version download

The most popular open source editor

EditPlus Chinese cracked version

EditPlus Chinese cracked version

Small size, syntax highlighting, does not support code prompt function

DVWA

DVWA

Damn Vulnerable Web App (DVWA) is a PHP/MySQL web application that is very vulnerable. Its main goals are to be an aid for security professionals to test their skills and tools in a legal environment, to help web developers better understand the process of securing web applications, and to help teachers/students teach/learn in a classroom environment Web application security. The goal of DVWA is to practice some of the most common web vulnerabilities through a simple and straightforward interface, with varying degrees of difficulty. Please note that this software