API 명세서 작성 연습
| 기능 | API URL | Method | Request | Response |
|---|---|---|---|---|
| 회원가입 | /api/sign-up | POST | { "id":"sparta75701", "password":"aaaa4321" } | { "message": "회원가입이 완료되었습니다." } |
| 로그인 | /api/sign-in | POST | { "id":"sparta75701", "password":"aaaa4321" } | { "message": "로그인 성공" } |
| 캐릭터 생성 | /api/create-character | POST | { "characterName":"EC2맨v" } | { "message": "EC2맨v 생성 완료 " } |
| 캐릭터 상세 조회 | /api/search-character/:characterId | GET | {} | { "data": { "characterName":"EC2맨v" ,"characterInfos": {"health": 500, "power": 100}} } |
| 캐릭터 삭제 | /api/search-character/:characterId | DELETE | {} | { "data": "EC2맨v(이)가 삭제되었습니다." } |
| 아이템 생성 | /api/create-item | POST | { "item_name": "녹슨 검", "item_stat": {"power" : 2}, "item_price":300 } | { "data": { "item_code": 2, "item_name": "녹슨 검", "item_stat": { "power": 2 }, "item_price": 300, "characterInventoryId": null, "characterItemId": null } } |
| 아이템 수정 | /api/edit-item/:item_code | PATCH | { "item_name": "녹슨 검 리뉴얼", "item_stat": {"power" : 10}, "item_price":350 } | { "message": "아이템 정보 변경에 성공하였습니다." } |
| 아이템 목록 조회 | /api/items | GET | {} | { "data": [{ "itemcode": 2, "item_name": "녹슨 검 리뉴얼", "item_price": 350 }, {"item_code": 1, "item_name": "철 검리뉴얼", "item_price": 500 }] } |
| 아이템 상세 조회 | /api/items/:item_code | GET | {} | { "data": [{ "item_code": 2, "item_name": "녹슨 검 리뉴얼", "item_stat": {"power": 10 }, "item_price": 350 } ]} } |
API 명세서를 작성하다보니 고쳐야할 부분도 눈에 들어오고 좋은데, 쉽지않네요 이거...
