공부하는가비

[JAVA] Rest Api 호출 파라미터 정리 본문

개발/Java

[JAVA] Rest Api 호출 파라미터 정리

가비코코보리 2021. 11. 24. 08:00

Rest API 파라미터 타입

- header 파라미터: 리퀘스트 헤더에 포함된 파라미터. 보통 인증 혹은 권한 부여에 관련되어 있다.

- path 파라미터: 엔드포인트에서 쿼리문 이전의 파라미터.

- query string 파라미터: 쿼리문 내의 파라미터. 엔드포인트가 끝난 뒤 물음표 뒤에 온다.

- request body 파라미터: 리퀘스트 바디에 포함된 파라미터. 보통 JSON 형식으로 제출된다.

 

CRUD Method URL
목록 조회 GET /user
조회 GET /user/{userId}
생성 POST /user
수정 PUT /user/{userId}
삭제 DELETE /user/{userId}

 

 

1) header 파라미터 

인증, 권한부여 목적 (API키)

2) path 파라미터

예 ) /ipcam/alert/pushSend/{userId}

3) query string 파라미터 

특정 리소스 정의시, 정렬, 필터링시 

4) request body 파라미터

POST 전송시 JSON,XML 데이터 읽을 때 

 

JSON 형식 

{

	"days": 2,

	"units": "imperial",

	"time": 1433524597

}

Json형식을 VO 타입으로 받아 사용 

@RequestBody(required = false) UserVO token
 token.getU_token();

 

 

https://idratherbewriting.com/learnapidoc/docapis_more_about_authorization.html

'개발 > Java' 카테고리의 다른 글

[JAVA] FMC 웹 서버에서 안드로이드에 푸시 알림 보내기  (0) 2021.11.23
Java Spring mysql 연동시 root.xml  (0) 2021.11.12
Spring security 참고  (0) 2021.10.21
Rest API 란  (0) 2021.10.18
2021.06.22 Spring 설문조사 Project  (0) 2021.06.22
Comments