RESTful API 작성법


RESTful API

JSON 이용하자.

마지막이 / 로 끝나면 안 된다. _ 대신 – 를 사용한다. 소문자로 구성한다. 동사는 포함하지 않는다. 파일 확장자 표시하지 않는다.

HTTP method GET POST PUT/PATCH DELETE

상태코드 200 : 요청에 대한 성공(GET, PUT) 201 : created (POST) 204 : No content : 응답할 데이터가 없음(HTTP body가 없음) DELETE, PUT

400 bad request: 요청이 잘못되었음(에러 사유 표기) 400 bad request {“message”:“Parameter is not valid”} 400 bad request {“code”:-765, “more_info”:“https://aa.com/errors/-765”}

401 unauthorized : 로그인 안 되었음 403 forbidden : 권한이 인가되지 않았음. 로그인 되었는데, 권한이 없음 404 not found : 자원을 찾을 수 없음 409 conflict : 비지니스 로직상 요청을 처리하지 못한 경우 429 too many requests : 요청을 너무 많이 한 경우


답글 남기기

이메일 주소는 공개되지 않습니다. 필수 필드는 *로 표시됩니다