NEMV 2 - API 설계

최대 1 분 소요

NEMBV 참고 바람 This doc is deprecated: 위 링크로 대체되었습니다.(지난 과오..)

규격은 RESTful api의 형태로 제작한다.

url은 https://x.y/api 를 통해 데이터를 송수신하도록 한다.

session or token 등의 인증된 보안패킷만 송수신할 수 있다.

검색용 키값은 요청파라메터(url)로 전달하며 데이터는 body에 담아서 보낸다.

  1. POST : Create
    데이터 송신, 생성용이며 요청시 body에 데이터를 담아서 보냄

  2. GET : Retrieve
    데이터 수신, 조회용이며 요청시 조건 파라메터로 조절

  3. PUT : Update
    데이터 송신, 수정용이며 요청시 해당데이터의 키값을 파라메터로 보냄
    바디에는 수정할 만큼만 채워서 가변으로 보냄

  4. DELETE : Delete 데이터 송신, 삭제용이며 요청시 해당데이터의 키값을 파라메터로 보냄

데이터를 보낼때 방법이 여러가지여서 주소창에 넣을 때도 있었고 바디에 조건을 넣을 때도 있었는데..
경험상 용도에 가장 적합한 구조가 위의 구조 인 것 같다.

이 문서는 다음 문서 내용과 같이 업데이트 시키도록 하겠다..

댓글남기기