目次
回复内容:
ホームページ バックエンド開発 PHPチュートリアル 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>
ログイン後にコピー
ログイン後にコピー

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>
ログイン後にコピー
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

AI Hentai Generator

AI Hentai Generator

AIヘンタイを無料で生成します。

ホットツール

メモ帳++7.3.1

メモ帳++7.3.1

使いやすく無料のコードエディター

SublimeText3 中国語版

SublimeText3 中国語版

中国語版、とても使いやすい

ゼンドスタジオ 13.0.1

ゼンドスタジオ 13.0.1

強力な PHP 統合開発環境

ドリームウィーバー CS6

ドリームウィーバー CS6

ビジュアル Web 開発ツール

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

LinuxターミナルでPythonバージョンを表示するときに発生する権限の問題を解決する方法は? LinuxターミナルでPythonバージョンを表示するときに発生する権限の問題を解決する方法は? Apr 01, 2025 pm 05:09 PM

LinuxターミナルでPythonバージョンを表示する際の許可の問題の解決策PythonターミナルでPythonバージョンを表示しようとするとき、Pythonを入力してください...

あるデータフレームの列全体を、Python内の異なる構造を持つ別のデータフレームに効率的にコピーする方法は? あるデータフレームの列全体を、Python内の異なる構造を持つ別のデータフレームに効率的にコピーする方法は? Apr 01, 2025 pm 11:15 PM

PythonのPandasライブラリを使用する場合、異なる構造を持つ2つのデータフレーム間で列全体をコピーする方法は一般的な問題です。 2つのデータがあるとします...

Pythonパラメーター注釈は文字列を使用できますか? Pythonパラメーター注釈は文字列を使用できますか? Apr 01, 2025 pm 08:39 PM

Pythonパラメーター注釈の代替使用Pythonプログラミングでは、パラメーターアノテーションは、開発者が機能をよりよく理解して使用するのに役立つ非常に便利な機能です...

Pythonクロスプラットフォームデスクトップアプリケーション開発:どのGUIライブラリが最適ですか? Pythonクロスプラットフォームデスクトップアプリケーション開発:どのGUIライブラリが最適ですか? Apr 01, 2025 pm 05:24 PM

Pythonクロスプラットフォームデスクトップアプリケーション開発ライブラリの選択多くのPython開発者は、WindowsシステムとLinuxシステムの両方で実行できるデスクトップアプリケーションを開発したいと考えています...

なぜ私のコードはAPIによってデータを返しているのですか?この問題を解決する方法は? なぜ私のコードはAPIによってデータを返しているのですか?この問題を解決する方法は? Apr 01, 2025 pm 08:09 PM

なぜ私のコードはAPIによってデータを返しているのですか?プログラミングでは、APIが呼び出すときにヌル値を返すという問題に遭遇することがよくあります。

uvicornは、serving_forever()なしでhttpリクエストをどのように継続的に聞いていますか? uvicornは、serving_forever()なしでhttpリクエストをどのように継続的に聞いていますか? Apr 01, 2025 pm 10:51 PM

UvicornはどのようにしてHTTPリクエストを継続的に聞きますか? Uvicornは、ASGIに基づく軽量のWebサーバーです。そのコア機能の1つは、HTTPリクエストを聞いて続行することです...

Pythonスクリプトは、特定の場所のカーソル位置への出力をどのようにクリアしますか? Pythonスクリプトは、特定の場所のカーソル位置への出力をどのようにクリアしますか? Apr 01, 2025 pm 11:30 PM

Pythonスクリプトは、特定の場所のカーソル位置への出力をどのようにクリアしますか? Pythonスクリプトを書くときは、以前の出力をカーソル位置にクリアするのが一般的です...

GoogleとAWSはパブリックピピイメージソースを提供していますか? GoogleとAWSはパブリックピピイメージソースを提供していますか? Apr 01, 2025 pm 05:15 PM

多くの開発者はPypi(PythonPackageIndex)に依存しています...

See all articles