Incorrect `links` URL

オープン
#1,076 コメント 1 件 リアクション 5 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
rails, ruby
領域
api, backend

調査の方向性

routes.rb の例と person モデルのリソースリンク生成から始めます。/api/v3 URL を示すレスポンスを再現し、これらのリンクが /v3 ルートを基準にどのように組み立てられているかを追跡します。リソースリンクとリレーションシップリンクが /api プレフィックスを省略しつつ、宣言されたルートに引き続き解決されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

We need to omit the api out of the links URLs (eg: http://localhost:3001/api/v3/people). Our valid URL should look like this: http://localhost:3001/v3/people.

Here's a sample of how our routes.rb file is built:

Our routes.rb:

Rails.application.routes.draw do
  scope module: :api do
    namespace :v3 do
      jsonapi_resources :people
      jsonapi_resources :providers
    end
  end
end

According to the rake routes task on our person model:

v3_people GET       /v3/people(.:format)       api/v3/people#index
          POST      /v3/people(.:format)       api/v3/people#create
v3_person GET       /v3/people/:id(.:format)   api/v3/people#show
          PATCH     /v3/people/:id(.:format)   api/v3/people#update
          PUT       /v3/people/:id(.:format)   api/v3/people#update
          DELETE    /v3/people/:id(.:format)   api/v3/people#destroy

But the response output looks like this:

{
    "data": {
        "id": "1",
        "type": "people",
        "links": {
            "self": "http://localhost:3001/api/v3/people/1"
        },
        "attributes": {
            "full-name": "Chad Taylor",
            "first-name": "Chad",
            "last-name": "Taylor",
            "uuid": "dab4e5e6-ba50-42b4-9633-50a952d2e811"
        },
        "relationships": {
            "providers": {
                "links": {
                    "self": "http://localhost:3001/api/v3/people/1/relationships/providers",
                    "related": "http://localhost:3001/api/v3/people/1/providers"
                }
            }
        }
    }
}

If we can get the /api omitted from the links, all will be golden.

Thanks in advance.

主要言語
Ruby
スター
2.3k
フォーク
546
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

JSONAPI-Resources/jsonapi-resources のほかの issue

JSONAPI-Resources/jsonapi-resources の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。