Restful 한 API 를 만들기 위한 URL 고민이 또 생겼습니다.

Question

정답이 없다는걸 알면서도 매번 만들고 뜯어고치고 반복하다보니,차라리 다른분들의 의견을 한번 들어보고 싶습니다.중첩 구조일 때 URL 표기하는 규칙을 만들기가 너무 모호한 상태입니다.어떤 활성화 된 장치들의 집합이 있습니다. 이를 &#34;device&#34; 라고 칭하겠습니다.그리고 이 device들은 통신용 디바이스일 수 있고, 사용자 디바이스 일 수 있습니다. 즉 기지국 또는 휴대폰일 수 있는 상황입니다. 이걸 모두 통칭 &#34;Device&#34; 입니다.하지만 통신용 과 사용자 디바이스는 엄연히 다릅니다. 그래서,통신용 디바이스들은 network 라는 묶음에, 사용자 디바이스는 user 라는 묶음에 들어있습니다.그럼 이제 통신용 디바이스 라고 볼 데이터 중에 공유기가 있다고 가정하겠습니다. 이를 router 라고 하겠습니다. (활성화가 되었을 수도, 아닐 수도 있습니다.)그 다음, 사용자 디바이스 라고 볼 데이터 중에 휴대폰이 있다고 가정하겠습니다. 이를 phone 라고 하겠습니다. (활성화가 되었을 수도, 아닐 수도 있습니다.)이런 상황에, 이제 조건에 따른 Rest API 를 만들어보자면모든 활성화 된 디바이스를 줘/device모든 활성화 된 통신용 디바이스를 줘/device/network모든 활성화 된 사용자 디바이스를 줘/device/user여기까지는 딱히 문제가 없었습니다.그러면, 다음 조건은 이렇습니다.모든 활성화 된 router 정보를 줘/device/network/router/device/router모든 활성화 된 phone 에 대한 정보를 줘/device/network/phone/device/phone여기서부터 고민입니다. 두가지 모두 말이 되는 것 같으면서도 너무 길거나 너무 축약하지 않았나 하는 생각이 듭니다.첫번째는 이게 맞지 않나 싶으면서도 너무 중첩이 길어지는 느낌입니다. 만약 phone 하위에 중첩이 또 있다면..? 예를 들어 그 중에서도 특정 폰 모델만 줘 해버리면/device/network/phone/:phoneModel처럼 되어버리니까 너무 길어지지 않나 싶습니다, 이렇게 하나하나 다 표기하는게 과연 맞는가? 싶은거죠.두번째는 특정 리소스를 달라는건데 묶음까지 표현하는건 너무 세부적으로 나눈게 아닌가? 활성화를 의미하는 device, 그리고 특정 리소스인 phone만 있으면 되지 않나? 라는 개념으로 접근한건데,그럼/device/network/device/phone라는 모양새가 되는거라 2번째 중첩 부분이 이상해지는 느낌을 받았습니다.묶음이 위치해야할 자리에 바로 리소스를 달라고하는게 말이 되는건가..? 인거죠.선생님들이라면 어떤 방식을 택하시겠습니까?

Paimon · Answer

조건인경우 쿼리파라미터로 넣는 편입니다 없으면 전체,있으면 필터링 으로 동작하게요

Hee Sung Son · Answer

카테고리는 url로 해도 상관없고 상세조건인 경우에만 query param이나 json body로 조건을 받죠 경우의수가 많으니까요 일단 이 딜레마는 모든 조건을 url로만 표현하려고 해서 오는 딜레마 같습니다 조건을 테이블당 or 카테고리와 조건을 분리하시는게 어떨까요?

mirheeoj · Answer

집 주소 계층구조를 만드는데 방 갯수라든지 자동차 차종 등도 주소로 표현하시려는 듯한 느낌이 조금 듭니다.

ykd · Answer

내부 구조가 개념적으로/논리적으로 중첩되었다 할지라도 api path상으로 그것을 반드시 반영할 필요는 없다고 생각합니다.

초무쿤 · Answer

Filter라우터목록 중 A네트워크의 라우터만 조회/device/router?network=A 설계하실때 모델의 컨셉에 밎춰서 하시는게 직관적입니다.모델이 개판이면 API를 많이 추싱회해야된다는 딜레마가 있긴합니다만…

장독깨기 · Answer

Restful 에 너무 큰 의미 부여 하면서 고민할 필요 없습니다.그냥 편한게 하시고, 필터 적절히 사용하면서 어느 정도 일관성만 지켜주면 됩니다.사용자장치, 네트웍장치 모두 가져와야 한다. /devices모두 가져오는데 활성화된 장치만 가져온다. /devices?status=active(한꺼번에 모두 가져 올 일이 없다. /network_devices, /user_devices모두 가져 올 일도 있고, 계층이 확실해서 구조화 하고 싶고, 사용자장치, 네트웍 장치 별도로 하고 싶다./devices/networks/{kind}/{model}, /devices/users/{kind}/{model}kind 는 router, phone 이런 게 될 테고, model 은 해당 장치의 모델이 될텐데요,번거롭고 길다 생각들면 필터로 처리해도 됩니다.특정 장치를 가져오겠다. /devices/{device_id}너무 고민마시고 편하게 하세요. :)

Restful 한 API 를 만들기 위한 URL 고민이 또 생겼습니다.

6개의 답변

Q&A 목록