Share
Sign In
RESTful Functional Guide(작성중)
Paging, Ordering, Filtering, Field-Selecting
Paging
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 한 번에 모든 결과를 응답하지 않고 적당한 크기로 데이터 셋을 나눠서 응답한다.
Paging Key
page
per_page
start
limit
page
per_page
개발자 관점
offset
limit
어떤 key로 paging을 처리할지 변경될 수 있으니 개발자는 코드의 설정 값으로 언제든 key 이름을 변경할 수 있게 구현한다.
Ordering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트를 클라이언트의 요청에 맞게 정렬해 응답한다.
order라는 key를 사용한다.
오름차순: key
내림차순: -key
?order=-name: name 내림차순 name desc
?order=-name,level: name 내림차순, level 오름차순 name desc, level asc
Filtering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트 검색 조건을 요청할 수 있다.
AND, OR
=, !=
>, >=
<, >=
IN(OR), NOT IN
LIKE(include)
type = ssd or (cpu=1 or memory>=2) and staus != 04
Field-Selecting
Collection(리스트)에 대한 GET 요청의 경우(GET /users
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
include: ?fields=id,name
exclude: ?-fields=level
존재하지 않는 key
fields에 존재하는 key가 하나도 없는 경우, fields 모두 무시
(?fields=aaaaaa 혹은 ?fields=aaaaaa,bbbb)
fields에 key가 일부분만 존재하는 경우, 존재하는 key로만 selecting
(?fields=aaaaaa,name)
참고문헌 :
RESTful api 설계 가이드
Paging, Ordering, Filtering, Field-Selecting
Paging
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 한 번에 모든 결과를 응답하지 않고 적당한 크기로 데이터 셋을 나눠서 응답한다.
Paging Key
page
per_page
start
limit
page
per_page
개발자 관점
offset
limit
어떤 key로 paging을 처리할지 변경될 수 있으니 개발자는 코드의 설정 값으로 언제든 key 이름을 변경할 수 있게 구현한다.
Ordering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트를 클라이언트의 요청에 맞게 정렬해 응답한다.
order라는 key를 사용한다.
오름차순: key
내림차순: -key
?order=-name: name 내림차순 name desc
?order=-name,level: name 내림차순, level 오름차순 name desc, level asc
Filtering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트 검색 조건을 요청할 수 있다.
AND, OR
=, !=
>, >=
<, >=
IN(OR), NOT IN
LIKE(include)
type = ssd or (cpu=1 or memory>=2) and staus != 04
Field-Selecting
Collection(리스트)에 대한 GET 요청의 경우(GET /users
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
include: ?fields=id,name
exclude: ?-fields=level
존재하지 않는 key
fields에 존재하는 key가 하나도 없는 경우, fields 모두 무시
(?fields=aaaaaa 혹은 ?fields=aaaaaa,bbbb)
fields에 key가 일부분만 존재하는 경우, 존재하는 key로만 selecting
(?fields=aaaaaa,name)
참고문헌 :
RESTful api 설계 가이드
Paging, Ordering, Filtering, Field-Selecting
Paging
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 한 번에 모든 결과를 응답하지 않고 적당한 크기로 데이터 셋을 나눠서 응답한다.
Paging Key
page
per_page
start
limit
page
per_page
개발자 관점
offset
limit
어떤 key로 paging을 처리할지 변경될 수 있으니 개발자는 코드의 설정 값으로 언제든 key 이름을 변경할 수 있게 구현한다.
Ordering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트를 클라이언트의 요청에 맞게 정렬해 응답한다.
order라는 key를 사용한다.
오름차순: key
내림차순: -key
?order=-name: name 내림차순 name desc
?order=-name,level: name 내림차순, level 오름차순 name desc, level asc
Filtering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트 검색 조건을 요청할 수 있다.
AND, OR
=, !=
>, >=
<, >=
IN(OR), NOT IN
LIKE(include)
type = ssd or (cpu=1 or memory>=2) and staus != 04
Field-Selecting
Collection(리스트)에 대한 GET 요청의 경우(GET /users
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
include: ?fields=id,name
exclude: ?-fields=level
존재하지 않는 key
fields에 존재하는 key가 하나도 없는 경우, fields 모두 무시
(?fields=aaaaaa 혹은 ?fields=aaaaaa,bbbb)
fields에 key가 일부분만 존재하는 경우, 존재하는 key로만 selecting
(?fields=aaaaaa,name)
참고문헌 :
RESTful api 설계 가이드
Paging, Ordering, Filtering, Field-Selecting
Paging
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 한 번에 모든 결과를 응답하지 않고 적당한 크기로 데이터 셋을 나눠서 응답한다.
Paging Key
page
per_page
start
limit
page
per_page
개발자 관점
offset
limit
어떤 key로 paging을 처리할지 변경될 수 있으니 개발자는 코드의 설정 값으로 언제든 key 이름을 변경할 수 있게 구현한다.
Ordering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트를 클라이언트의 요청에 맞게 정렬해 응답한다.
order라는 key를 사용한다.
오름차순: key
내림차순: -key
?order=-name: name 내림차순 name desc
?order=-name,level: name 내림차순, level 오름차순 name desc, level asc
Filtering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트 검색 조건을 요청할 수 있다.
AND, OR
=, !=
>, >=
<, >=
IN(OR), NOT IN
LIKE(include)
type = ssd or (cpu=1 or memory>=2) and staus != 04
Field-Selecting
Collection(리스트)에 대한 GET 요청의 경우(GET /users
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
include: ?fields=id,name
exclude: ?-fields=level
존재하지 않는 key
fields에 존재하는 key가 하나도 없는 경우, fields 모두 무시
(?fields=aaaaaa 혹은 ?fields=aaaaaa,bbbb)
fields에 key가 일부분만 존재하는 경우, 존재하는 key로만 selecting
(?fields=aaaaaa,name)
참고문헌 :
RESTful api 설계 가이드
Paging, Ordering, Filtering, Field-Selecting
Paging
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 한 번에 모든 결과를 응답하지 않고 적당한 크기로 데이터 셋을 나눠서 응답한다.
Paging Key
page
per_page
start
limit
page
per_page
개발자 관점
offset
limit
어떤 key로 paging을 처리할지 변경될 수 있으니 개발자는 코드의 설정 값으로 언제든 key 이름을 변경할 수 있게 구현한다.
Ordering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트를 클라이언트의 요청에 맞게 정렬해 응답한다.
order라는 key를 사용한다.
오름차순: key
내림차순: -key
?order=-name: name 내림차순 name desc
?order=-name,level: name 내림차순, level 오름차순 name desc, level asc
Filtering
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 리스트 검색 조건을 요청할 수 있다.
AND, OR
=, !=
>, >=
<, >=
IN(OR), NOT IN
LIKE(include)
type = ssd or (cpu=1 or memory>=2) and staus != 04
Field-Selecting
Collection(리스트)에 대한 GET 요청의 경우(GET /users
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
) 리스트 결과의 일부분만 선택해서 응답받을 수 있다.
include: ?fields=id,name
exclude: ?-fields=level
존재하지 않는 key
fields에 존재하는 key가 하나도 없는 경우, fields 모두 무시
(?fields=aaaaaa 혹은 ?fields=aaaaaa,bbbb)
fields에 key가 일부분만 존재하는 경우, 존재하는 key로만 selecting
(?fields=aaaaaa,name)
참고문헌 :
RESTful api 설계 가이드
Paging, Ordering, Filtering, Field-Selecting
Paging
Collection(리스트)에 대한 GET 요청의 경우(GET /users) 한 번에 모든 결과를 응답하지 않고 적당한 크기로 데이터 셋을 나눠서 응답한다.
Paging Key
page
per_page
start
limit
page
per_page
개발자 관점