diff --git a/docs/create-rest-endpoint.md b/docs/create-rest-endpoint.md index dbf1d9e..ca2f04f 100644 --- a/docs/create-rest-endpoint.md +++ b/docs/create-rest-endpoint.md @@ -4,7 +4,7 @@ ## 設計 -HasuraはGraphQL QueryをREST化することが可能です。このハンズオンでは、次の仕様のREST APIエンドポイントを作成します。 +HasuraはGraphQL APIサーバーとして利用するだけでなく、REST APIサーバーとして利用することもできます。このハンズオンでは、GraphQL QueryをREST化し、次の仕様のREST APIエンドポイントを作成します。 | 名称 | HTTPメソッドとパス | 説明 | | ------------ | ------------------------ | ------------------------------------------------------------------------------------------------------------------- | @@ -15,6 +15,8 @@ HasuraはGraphQL QueryをREST化することが可能です。このハンズオ ページを取得するためのREST APIエンドポイントを作成します。 +![](https://lh3.googleusercontent.com/WpWX9e0zMECBpUvdyFXyPAxKauwgpNVAwGSLzjt3M99aeL9t90CrqZrdpEf39uh5SKPBeYvfMX0i6KvTuXf39_rccK1o7aohwFL_OCmz0TX-i0Lc2tlJpk5gPMdTrEqzKyElKvPzEQ=w1280) + コンソールのトップ画面のGraphiQLのパネルにアクセスし、次のコードを書きます。 ```graphql @@ -26,22 +28,22 @@ query getPage($id: Int!) { } ``` -![](https://lh3.googleusercontent.com/WpWX9e0zMECBpUvdyFXyPAxKauwgpNVAwGSLzjt3M99aeL9t90CrqZrdpEf39uh5SKPBeYvfMX0i6KvTuXf39_rccK1o7aohwFL_OCmz0TX-i0Lc2tlJpk5gPMdTrEqzKyElKvPzEQ=w1280) - [REST]ボタンを選択し、REST APIエンドポイント作成フォームを表示します。次の必要事項を入力し、作成ボタンを選択しエンドポイントを作成します。 +![](https://lh3.googleusercontent.com/fKkiNL4nWYUtiG8OfAk8mhTxdJuZQclLLBWheVclr4EcC7ggsZzpI4mTYGQ-6pvWZWApa2acaUJKVjOFy5oHwqhtVfn4arYX01B29yUvOQwWPRIq-6JOBFNTfP_FxoNJNRaseYEMbw=w1280) + | 項目 | 説明 | 内容 | | -------- | ----------------------- | ---------- | | Name | エンドポイントの名称 | get page | | Location | `/api/rest/` 以降のパス | `page/:id` | | Method | HTTPメソッド | `GET` | -![](https://lh3.googleusercontent.com/fKkiNL4nWYUtiG8OfAk8mhTxdJuZQclLLBWheVclr4EcC7ggsZzpI4mTYGQ-6pvWZWApa2acaUJKVjOFy5oHwqhtVfn4arYX01B29yUvOQwWPRIq-6JOBFNTfP_FxoNJNRaseYEMbw=w1280) - ## 「ページの更新 (`PUT page/:id`)」エンドポイントの作成 ページを更新するためのREST APIエンドポイントを作成します。 +![](https://lh3.googleusercontent.com/yeEU1sF7DR3VA7tWn-FDofpFIfK93q2hssqnn25c_-0bnAbo8WdzdTahQ3HVst7hCniT5hJqHgWS9Pu9zTQorHxErtdp8PSFJmgsU6R0G_oPzF__Up-aSdHQWFc_uuWyVU_Ux50jlw=w1280) + コンソールのトップ画面のGraphiQLのパネルにアクセスし、次のコードを書きます。 ```graphql @@ -56,16 +58,14 @@ mutation putPage($id: Int!, $content: jsonb!) { } ``` -![](https://lh3.googleusercontent.com/yeEU1sF7DR3VA7tWn-FDofpFIfK93q2hssqnn25c_-0bnAbo8WdzdTahQ3HVst7hCniT5hJqHgWS9Pu9zTQorHxErtdp8PSFJmgsU6R0G_oPzF__Up-aSdHQWFc_uuWyVU_Ux50jlw=w1280) - [REST]ボタンを選択し、REST APIエンドポイント作成フォームを表示します。次の必要事項を入力し、作成ボタンを選択しエンドポイントを作成します。 +![](https://lh3.googleusercontent.com/NUKkifFtbdjjti9tga3fHp0-iIc4e48Cz2HrBOUngbaDad5an29hJ9ucn7kG3MXLIyZw80wpfG3aZZrS9kDEYUnl9cV3VB0oZ6LqIRKbHlgUGBF2PJJC9ifLCABZhmn1Rv8u9mZ8qw=w1280) + | 項目 | 説明 | 内容 | | -------- | ----------------------- | ---------- | | Name | エンドポイントの名称 | put page | | Location | `/api/rest/` 以降のパス | `page/:id` | | Method | HTTPメソッド | `PUT` | -![](https://lh3.googleusercontent.com/NUKkifFtbdjjti9tga3fHp0-iIc4e48Cz2HrBOUngbaDad5an29hJ9ucn7kG3MXLIyZw80wpfG3aZZrS9kDEYUnl9cV3VB0oZ6LqIRKbHlgUGBF2PJJC9ifLCABZhmn1Rv8u9mZ8qw=w1280) - 作成が完了すると作成したREST APIエンドポイントの一覧が表示されます。