예제를 선호하는 습관은 아무 문제가 없습니다. 답을 얻는 가장 빠른 방법입니다. 또한 예제는 시각적입니다. 텍스트 단락을 읽고 필요한 정보를 추출하는 것보다 시각적으로 예제를 구문 분석하는 것이 더 쉽습니다.
예:
제품을 나열하려면 여기서 가능한 유일한 동사 Index
인 경우 Products
컨트롤러 GET
의 조치를 사용해야합니다 (데이터베이스에서 제품을 작성, 수정 및 삭제하는 데 사용되는 조치에 대한 자세한 정보는 [영향 제품] 참조).
특정 제품에 대한 자세한 정보를 얻으려면 고유 한 식별자를 URI 끝에 추가하십시오. 사용 가능한 모든 제품 목록을 얻으려면 아무 것도 추가하지 마십시오. 매뉴얼의 [데이터 선택을위한 REST 필터] 섹션에 설명 된대로 필터를 사용할 수도 있습니다. 제품 목록은 1,000 개 항목으로 제한됩니다. 각 페이지가 여전히 1,000 개의 항목으로 제한되어 있으면 [Pagination]을 사용하여 전체 목록을 탐색 할 수 있습니다.
서비스에서 재고 수량을 새로 고치도록 강제 할 수도 있습니다. 이를로 설정하면 refresh-quantities
됩니다.
상세하지만 지루하고 거의 읽을 수 없습니다. 링크를 따라야한다는 사실은 상황을 더욱 악화시킵니다. 샘플을 추가하면 이해하기가 훨씬 쉬워집니다.
GET 제품 / 인덱스 /
GET 제품 / 인덱스 / 12345 /
GET 제품 / 인덱스 /? skip = 100 & take = 20
GET 제품 / 인덱스 /? category = 12
GET 제품 / 인덱스 /?price=0..39.90
GET 제품 / 인덱스 /? category = 12 & skip = 100 & take = 20
예제 만 사용한다는 사실이 문제가 될 수 있습니다. 예제 사용을 중단하지 말고 일단 아이디어를 얻은 후에는 더 자세한 문서가 도움이 될 수 있습니다. 예를 들어, 위의 샘플은 제품 목록이 1,000 개로 제한되어 있음을 보여주지 않습니다. 해당 문서를 읽어야합니다.
언제 문서를 읽어야하는지 알고 있습니까?
API 또는 라이브러리가 예상대로 작동하지 않을 때마다 예를 들어, 샘플을 잡고 다음을 수행하십시오.
GET 제품 / 색인 /? 건너 뛰기 = 6000 & take = 3000
어떤 이유로 든, 데이터베이스에 2 만 개가 넘는 제품이있는 동안 3 000 개 미만의 항목을 반환합니다. 같은 여기에, API가 작동하지 않는 당신이 예상, 그래서 자세한 문서를 읽을 수있는 좋은 시간입니다.