"REST API 설계"의 두 판 사이의 차이

잔글 (Jmnote 사용자가 API 설계 문서를 REST API 설계 문서로 옮겼습니다)
 
(사용자 2명의 중간 판 24개는 보이지 않습니다)
1번째 줄: 1번째 줄:
==개요==
;REST API 설계
;API 설계
==예시 1==
{{참고|글쓰기 API 설계}}
{| class='wikitable'
! 용도 !! Create !! Read !! Update !! Delete
|-
! METHOD || POST || GET || PUT || DELETE
|-
| /posts || 글 작성★ || 글 목록 인출★ || 대량 수정 || 글 모두 삭제
|-
| /posts/123 || - || 123번 글 인출★ || 123번 글 수정★ || 123번 글 삭제★
|}


==예시 2==
{| class='wikitable'
{| class='wikitable'
! 구분 !! Create !! Read !! Update !! Delete
! 구분 !! POST !! GET !! PUT !! DELETE
|-
| /pet || ● ||  || ● ||
|-
| /pet/findByStatus ||  || ● ||  ||
|-
| /pet/findByTags ||  || ● ||  ||
|-
| /pet/아이디 || ● || ● ||  || ●
|-
| /pet/아이디/uploadImage || ● ||  ||  ||
|-
| /store/inventory ||  || ● ||  ||
|-
| /store/order || ● ||  ||  ||
|-
| /store/order/아이디 ||  ||  ||  || ●
|-
| /store/order/아이디 ||  || ● ||  ||
|-
| /user || ● ||  ||  ||
|-
| /user/createWithArray || ● ||  ||  ||
|-
| /user/createWithList || ● ||  ||  ||
|-
|-
| METHOD || POST || GET || PUT || DELETE
| /user/login || || || ||  
|-
|-
| /posts || 글 작성 || 글 목록 인출 || 대량 수정 || 글 모두 삭제
| /user/logout || || || ||  
|-
|-
| /posts/123 || - || 123번 글 인출 || 123번 글 수정 || 123번 글 삭제
| /user/아이디 || || || ||
|}
|}


==같이 보기==
==같이 보기==
*[[REST]]
* [[REST API]]
* [[REST API 오류 응답 설계]]
* [[CRUD 4색 배색]]
* [[페이크 REST API 서버 JSONPlaceholder]]


==참고 자료==
==참고==
*http://bcho.tistory.com/954
*http://bcho.tistory.com/954
*http://petstore.swagger.io/
*http://wp-api.org/#posts
*http://www.restapitutorial.com/lessons/httpmethods.html
* https://aws.amazon.com/ko/blogs/korea/werner-vogels-lesson-learned-for-good-api-design/ Werner Vogels – 좋은 API 디자인을 위한 6가지 배운 점 《Amazon Web Services 한국 블로그》 2022-01-25


[[분류: API]]
[[분류: REST API]]

2022년 1월 25일 (화) 09:56 기준 최신판

REST API 설계

1 예시 1[ | ]

용도 Create Read Update Delete
METHOD POST GET PUT DELETE
/posts 글 작성★ 글 목록 인출★ 대량 수정 글 모두 삭제
/posts/123 - 123번 글 인출★ 123번 글 수정★ 123번 글 삭제★

2 예시 2[ | ]

구분 POST GET PUT DELETE
/pet
/pet/findByStatus
/pet/findByTags
/pet/아이디
/pet/아이디/uploadImage
/store/inventory
/store/order
/store/order/아이디
/store/order/아이디
/user
/user/createWithArray
/user/createWithList
/user/login
/user/logout
/user/아이디

3 같이 보기[ | ]

4 참고[ | ]

문서 댓글 ({{ doc_comments.length }})
{{ comment.name }} {{ comment.created | snstime }}