Skip to content

Latest commit

 

History

History
176 lines (126 loc) · 7.12 KB

03-api.ja.md

File metadata and controls

176 lines (126 loc) · 7.12 KB
Raw

STEP3: 出品APIを作る

1. APIをたたいてみる

📖 Reference

curlをインストール

1. curlをインストールする

もしcurlがインストールされていなければ、curlコマンドを使用するとcommand not foundエラーが返ってきます。 その場合、curlをインストールする必要があります。 このcurlのインストール方法は、macOS、Linux、Windows Subsystem for Linux (WSL)で使用できます。

$ brew install curl

2. curlのバージョンをチェックする

$ curl　--version

GETリクエスト

サービスをローカルで立ち上げると、ブラウザで http://127.0.0.1:9000 からサービスにアクセスすることができるようになりました。 次に、curlというコマンドを使ってアクセスをしてみます。 新しいターミナルを開き、次のコマンドを入力してください。curlがインストールされていない場合、インストールしてください。

curl -X GET 'http://127.0.0.1:9000'

ブラウザと同じように{"message": "Hello, world!"} がコンソール上で返ってくることを確認します。

POSTリクエスト

サンプルコードには /items というエンドポイントが用意されています。 こちらのエンドポイントをcurlで叩いてみます。

$ curl -X POST 'http://127.0.0.1:9000/items'

このエンドポイントは、コールに成功すると{"message": "item received: <name>"} というレスポンスが返ってくることが期待されていますが、違ったレスポンスが返ってきてしまいます。

コマンドを以下のように修正することで、{"message": "item received: jacket"}が返ってきますが、なぜそのような結果になるのか調べてみましょう。

$ curl -X POST \
  --url 'http://localhost:9000/items' \
  -d name=jacket

🔰 Point

  • POSTとGETのリクエストの違いについて調べてみましょう
  • ブラウザで http://127.0.0.1:9000/items にアクセスしても {"message": "item received: <name>"} が返ってこないのはなぜでしょうか？
    • アクセスしたときに返ってくるHTTPステータスコードはいくつですか？
    • それはどんな意味をもつステータスコードですか？

2. 新しい商品を登録する

商品を登録するエンドポイントを作成します。

📖 Reference

準備されているPOST /itemsのエンドポイントはnameという情報を受け取れます。 ここにcategoryの情報も受け取れるように変更を加えます。

  • name: 商品の名前 (string)
  • category: 商品のカテゴリ(string)

このままではデータの保存ができないので、jsonファイルに保存するようにしましょう。 items.json というファイルを作り、そこのitemsというキーに新しく登録された商品を追加するようにしましょう。

商品を追加すると、items.jsonの中身は以下のようになることを期待しています。

{"items": [{"name": "jacket", "category": "fashion"}, ...]}

3. 商品一覧を取得する

GETで/itemsにアクセスしたときに、登録された商品一覧を取得できるようにエンドポイントを実装しましょう。 以下のようなレスポンスを期待しています。

# 商品の登録
$ curl -X POST \
  --url 'http://localhost:9000/items' \
  -d 'name=jacket' \
  -d 'category=fashion'
# /itemsにPOSTリクエストを送った時のレスポンス
{"message": "item received: jacket"}
# 登録された商品一覧
$ curl -X GET 'http://127.0.0.1:9000/items'
# /itemsにGETリクエストを送った時のレスポンス
{"items": [{"name": "jacket", "category": "fashion"}, ...]}

4. 画像を登録する

商品情報に画像(image)を登録できるように、GET /itemsとPOST /itemsのエンドポイントを変更します。

  • 画像は images というフォルダを作成し保存します
  • ポストされた画像のファイルを sha256 で hash化し、<hash>.jpgという名前で保存します
  • itemsに画像のファイル名をstringで保存できるように変更を加えます
# ローカルから.jpgをポストする
curl -X POST \
  --url 'http://localhost:9000/items' \
  -F 'name=jacket' \
  -F 'category=fashion' \
  -F 'image=@images/local_image.jpg'
{"items": [{"name": "jacket", "category": "fashion", "image_name": "510824dfd4caed183a7a7cc2be80f24a5f5048e15b3b5338556d5bbd3f7bc267.jpg"}, ...]}

🔰 Point

  • Hash化とはなにか？
  • sha256以外にどんなハッシュ関数があるか調べてみましょう

5. 商品の詳細を返す

商品の詳細情報を取得する GET /items/<item_id> というエンドポイントを作成します。

$ curl -X GET 'http://127.0.0.1:9000/items/1'
{"name": "jacket", "category": "fashion", "image_name": "..."}

6. (Optional) Loggerについて調べる

http://127.0.0.1:9000/image/no_image.jpgにアクセスしてみましょう。 no imageという画像が帰ってきますが、 コード中にある

Image not found: <image path>

というデバッグログがコンソールに表示されません。 これはなぜか、調べてみましょう。 これを表示するためには、コードのどこを変更したらいいでしょうか？

🔰 Point

  • Log levelとは？
  • webサーバーでは、本番はどのログレベルまで表示する？

🔰 Point

以下のキーワードについて理解しましょう

  • port (ポート番号)
  • localhost, 127.0.0.1
  • HTTPリクエストメソッド (GET, POST...)
  • HTTPステータスコード (1XX, 2XX, 3XX, 4XX, 5XXはそれぞれどんな意味を持ちますか？)

Next

STEP4: データベース