From 2bc92143f54e396afb04ed975c7807e17c0cd65b Mon Sep 17 00:00:00 2001
From: devxb <develxb@gmail.com>
Date: Sat, 26 Oct 2024 22:12:39 +0900
Subject: [PATCH] =?UTF-8?q?docs:=20=EB=B0=B0=EA=B2=BD=20=EA=B5=AC=EB=A7=A4?=
 =?UTF-8?q?,=EB=B3=80=EA=B2=BD,=EC=A1=B0=ED=9A=8C=20api=EB=AA=85=EC=84=B8?=
 =?UTF-8?q?=EB=A5=BC=20=EC=B6=94=EA=B0=80=ED=95=9C=EB=8B=A4?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/api/render/chage_my_background.md | 22 +++++++++++++++++++
 docs/api/render/get_my_backgrounds.md  | 29 ++++++++++++++++++++++++++
 docs/api/shop/buy_background.md        | 23 ++++++++++++++++++++
 docs/api/shop/get_background.md        | 29 ++++++++++++++++++++++++++
 4 files changed, 103 insertions(+)
 create mode 100644 docs/api/render/chage_my_background.md
 create mode 100644 docs/api/render/get_my_backgrounds.md
 create mode 100644 docs/api/shop/buy_background.md
 create mode 100644 docs/api/shop/get_background.md

diff --git a/docs/api/render/chage_my_background.md b/docs/api/render/chage_my_background.md
new file mode 100644
index 0000000..31db3bc
--- /dev/null
+++ b/docs/api/render/chage_my_background.md
@@ -0,0 +1,22 @@
+## Change my background
+
+배경을 변경합니다
+
+## Request
+### HTTP METHOD : `PUT`
+
+### url : `https://render.gitanimals.org/users/backgrounds`
+
+### PathVariable
+- {username}: 사용자의 이름
+
+### RequestHeader
+- Authorization: `{token}`
+
+## Response
+
+```json
+{
+  "type": "SNOWY"
+}
+```
diff --git a/docs/api/render/get_my_backgrounds.md b/docs/api/render/get_my_backgrounds.md
new file mode 100644
index 0000000..926e3b6
--- /dev/null
+++ b/docs/api/render/get_my_backgrounds.md
@@ -0,0 +1,29 @@
+## Get my background
+
+내가 갖고있는 모든 배경을 조회합니다.
+
+## Request
+### HTTP METHOD : `GET`
+
+### url : `https://render.gitanimals.org/users/{username}/backgrounds`
+
+### PathVariable
+- {username}: 사용자의 이름
+
+## Response
+
+```json
+{
+  "id": "1",
+  "name": "devxb",
+  "backgrounds": [
+    {
+      "type": "SNOWY"
+    },
+    {
+      "type": "WHITE"
+    }
+    ...
+  ]
+}
+```
diff --git a/docs/api/shop/buy_background.md b/docs/api/shop/buy_background.md
new file mode 100644
index 0000000..094e607
--- /dev/null
+++ b/docs/api/shop/buy_background.md
@@ -0,0 +1,23 @@
+## Buy background
+
+배경화면을 구매합니다.
+
+## Request
+
+### HTTP METHOD : `POST`
+
+### url : `https://api.gitanimals.org/shops/backgrounds`
+
+### RequestHeader
+
+- Authorization: `{token}`
+
+### Response Body
+
+200 OK
+
+```json
+{
+  "type": "SNOWY"
+}
+```
diff --git a/docs/api/shop/get_background.md b/docs/api/shop/get_background.md
new file mode 100644
index 0000000..98e478f
--- /dev/null
+++ b/docs/api/shop/get_background.md
@@ -0,0 +1,29 @@
+## Get background
+
+모든 구매가능한 배경을 조회합니다.
+
+## Request
+
+### HTTP METHOD : `GET`
+
+### url : `https://api.gitanimals.org/shops/backgrounds`
+
+### Response Body
+
+200 OK
+
+```json
+{
+  "backgrounds": [
+    {
+      "type": "SHOP",
+      "price": "100000"
+    },
+    {
+      "type": "SNOWY",
+      "price": "100000"
+    },
+    ...
+  ]
+}
+```