개발/프로젝트

API 명세서 초안

prpn97 2023. 4. 18. 00:08

API가 무엇인지 초보의 입장에서 간략하게 이해한대로 정리해보았습니다.

궁금하신 분들은 이전 포스팅을 참고해주세요.

https://prpn97.tistory.com/37

 

API? REST API? 란 무엇인가.

첫 프로젝트를 진행하며 api 명세서를 작성하는 것으로 처음을 장식하려 한다. 그런데 시작한다고 하지만 어떻게, 심지어 무엇을 해야하는지도 모르겠다. 그래서 먼저 api가 무엇인지 알아보도록

prpn97.tistory.com

USER    
회원가입 POST /api/signup
로그인 POST /api/login
CATEGORY    
카테고리 조회 GET /category
카테고리 생성 POST /category
카테고리 수정 PATCH /category/:id
카테고리 삭제 DELETE /category/:id
ORDER    
주문 생성 POST /orders
주문 전체 조회(admin) GET /orders
주문 전체 조회(user) GET /orders/:user-id
주문 상세 조회 GET /orders/item/:user-id
주문 수정 PATCH /orders/:order-id
주문 삭제 DELETE /orders/:order-id
PRODUCT    
상품 전체 조회 GET /products
카테고리 종속 상품 조회 GET /products/:category-id
상품 상세 조회 GET /products/item/:id
상품 생성 POST /products
상품 수정 PATCH /products/:product-id
상품 삭제 DELETE /products/:product-id
MYPAGE    
사용자 정보 조회 GET /api/userlist
사용자 정보 수정 PATCH /api/users
사용자 정보 삭제 DELETE /api/delete
특정 사용자 조회 GET /api/:user-id

 

728x90