Skip to content

Commit

Permalink
docs: 배경 구매,변경,조회 api명세를 추가한다
Browse files Browse the repository at this point in the history
  • Loading branch information
devxb committed Oct 26, 2024
1 parent 0da40f3 commit 2bc9214
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/api/render/chage_my_background.md
Original file line number Diff line number Diff line change
@@ -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"
}
```
29 changes: 29 additions & 0 deletions docs/api/render/get_my_backgrounds.md
Original file line number Diff line number Diff line change
@@ -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"
}
...
]
}
```
23 changes: 23 additions & 0 deletions docs/api/shop/buy_background.md
Original file line number Diff line number Diff line change
@@ -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"
}
```
29 changes: 29 additions & 0 deletions docs/api/shop/get_background.md
Original file line number Diff line number Diff line change
@@ -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"
},
...
]
}
```

0 comments on commit 2bc9214

Please sign in to comment.