デザイン

https://www.figma.com/file/tA2ZeeO40PE3p2IKu57WEq/%E3%82%B5%E3%83%9D%E3%83%BC%E3%82%BF%E3%83%BC%E3%82%BA%E3%83%8F%E3%83%83%E3%82%AB%E3%82%BD%E3%83%B3%E3%83%87%E3%82%B6%E3%82%A4%E3%83%B3?type=design&node-id=0-1&mode=design

環境構築

.envファイルを作成

touch .env
# Windowsは ni .env

HOST_IPに自分のパソコンのIPアドレスを代入する

起動は以下を実行

docker compose run --rm frontend-react-app npm i
docker compose up --build

docker exec -it api bash
# コンテナの中に入って
go mod tidy
go run main.go

Reactのディレクトリ構成

./frontend-react-app/README.md を参照

エンドポイント

GET /restaurants・・・店舗一覧を取得する
GET /restaurants/:id・・・特定の店舗の情報を取得する
GET /restaurants/categories・・・店舗のカテゴリ一覧を取得する
GET /restaurants/{id}/menus・・・特定の店舗のメニュー一覧を取得する
GET /restaurants/:id/menus/:menuid・・・特定の店舗の特定のメニューを取得する
GET /restaurants/:id/menus/yosan・・・特定の店舗で予算内でのセットを返す
GET /menus/categories・・・メニューのカテゴリ一覧を取得する
POST /restaurants/:id/menus/add・・・メニューを追加する
POST /restaurants/:id/menus/edit・・・メニューを編集する
POST /restaurants/:id/menus/delete・・・メニューを削除する
POST /restaurants/login・・・ログインする（店）
POST /restaurants/signup・・・新規登録する（店）
POST /restaurants/edit・・・店舗情報を編集する

店を新規登録をする方法

method: POST

bodyに以下のようなjsonを入れることで新規登録ができます。

{
    "email": "[email protected]",
    "password": "123456",
    "name": "hogehoge",
    "phone_number": "853985930",
    "address": "fugafuga",
    "description": "hogefuga",
    "category_id": 1
}

登録する事ができれば次のようなレスポンスが帰ってきます。
``` json
{
    "message": "ok",
    "restaurant_id": 4
}

登録に失敗すると次のようなレスポンスが帰ってきます。

{"message":"failed to create restaurant"}

ログインする方法

method: POST

bodyに以下のようなjsonを入れてください。

{
    "email": "[email protected]",
    "password": "123456"
}

ログインできれば以下のようなレスポンスが帰ってきます

{
    "message": "ok",
    "restaurant_id": 1
}

ログインできなかった場合は以下のようなレスポンスです

{
    "message": "unauthorized"
}

店の情報を編集する方法

method POST

/restaurants/editに次のようなjsonをbodyに入れてPOSTしてください。

{
    "id": 3,
    "email": "[email protected]",
    "password": "hogehoge",
    "name": "hogehogeラーメン",
    "phone_number": "1234556",
    "address": "地球",
    "description": "lorem ipsum",
    "category_id": 1
}

メニューを検索する方法

/restaurants/{id}/menusに次のURLクエリを付与する事で検索ができます。

• lower・・・X円以下のメニューを検索する
• higher・・・X円以上のメニューを検索する
• keyword・・・メニュー名で検索する

X円で注文できるメニューのセットを返す方法

/restaurants/1/menus/yosan に以下のURLクエリを付与する事で検索ができます。

• price・・・注文するセットの予算

2000円で注文できるメニューのセットを返す場合は次のようになります。 localhost:8080/restaurants/1/menus/yosan?price=2000

Warning 2000円以下の数字を渡すとエラーが返ってきます。

店の検索

/restaurantsに次のURLクエリを付与する事で検索ができます。

• keyword・・・店名で検索する

メニューを編集する方法

/restaurants/:id/menus/editのbodyに以下のようなjsonを入れてPOSTしてください。

{
    "id": 17,
    "name": "鮪",
    "price": 1000,
    "description": "hogehogehogehoge",
    "restaurant_id": 1,
    "category": "粉料理",
    "photo_url": "",
    "is_sold_out": false,
    "like_count": 0
}

メニューを追加する方法

method POST

/restaurants/:id/menus/addのbodyに以下のようなjsonを入れてPOSTしてください。

{
    "name": "鯖",
    "price": 1000,
    "description": "hogehogehogehoge",
    "restaurant_id": 1,
    "category": "粉料理",
    "photo_url": "",
    "is_sold_out": false,
    "like_count": 0
}

メニューを削除する方法

method POST /restaurants/:id/menus/deleteのbodyに以下のようなjsonを入れてPOSTしてください。

{
    "id": 17
}

実装予定のエンドポイント

自分実装する場合はGitHubのissueにアサインしてください。

• POST /restaurants/yosan・・・bodyに予算をくっつけて送るとその予算で食べられるメニューを返す
• GET /restaurants/{id}/menus/{id}・・・指定したメニューの情報を返す。
• POST /restaurants/signup・・・新規登録する
• POST /restaurants/{id}/menus/action・・・メニューの追加とか削除とか編集とか