경로 예를 들어/사용자/5 : 특정 리소스의 유일한 위치. 쿼리 매개 변수 (선택 사항) 예를 들어 Limit = 10은 10 개의 결과 만 포함하도록 응답을 필터링하는 데 사용됩니다. 예를 들어, ID 5가있는 사용자에게 얻으려면/user/5를 사용합니다.
REST API Convention
다음은 편안한 API를 구축 할 때 따라야 할 일부 규칙입니다.
동사 대신 명사 사용 : 예를 들어, 사용자를 추가하려면/사용자 엔드 포인트를 사용하고/사용자/추가 엔드 포인트 대신 게시물 요청을 사용해야합니다. API는 여러 유형의 요청을 동일한 URL로 처리 할 수 있도록 개발해야합니다.
경로는 사례에 민감하며 밑줄 대신 소문자와 하이픈을 사용해야합니다. 예를 들어, /users-list는 /users_list보다 바람직합니다.
이러한 모든 규칙은 따라야 할 엄격한 휴식 기준이 없기 때문에 원칙입니다. 그러나이 가이드 라인을 사용하면 API가 일관되고 친숙하며 읽고 이해하기 쉽습니다.
REST 대안
REST는 훌륭한 도구이지만 경우에 따라 도움이되는 몇 가지 대안이 있습니다.
SOAP
SOAP (Simple Object Access Protocol)는 1998 년에 생성 된 API이며 휴식 전 매우 인기가있었습니다. 그들 사이에는 몇 가지 주요 차이점이 있습니다. 첫째, SOAP는 응답 형식에 대해 훨씬 엄격한 제한을 가지고 있습니다. 둘째, SOAP는 JSON 대신 XML을 사용하는데, 이는 레거시 애플리케이션에 유용 할 수 있지만 일반적으로 동등한 JSON보다 더 크고 복잡합니다. 마지막으로 SOAP는 HTTP에서 잘 작동하지만 SMTP와 같은 프로토콜도 지원합니다.
GraphQL
GraphQL은 Facebook에서 생성 한 최신 API 형식으로 클라이언트가 서버에 필요한 데이터를 정확하게 알 수 있도록하여 데이터를 가져 오는 데 필요한 HTTP 요청 수를 줄이기 위해 목표로합니다. GraphQL은 URL 경로를 사용하는 대신 클라이언트가 필요한 데이터를 정의하여 클라이언트가 한 번의 요청에서 필요한 모든 것을 얻을 수 있도록 사용자 정의 구문을 가지고 있습니다.
GraphQL에 대한 훌륭한 소개를 보려면이 그래프 QL 자습서를 확인하십시오.
결론
이 기사에서는 휴식과 편안한 API가 무엇인지, HTTP 요청 방법 및 응답 코드 작동, API URL의 구조 및 일반적인 편안한 API 규칙을 배웁니다. 다음 튜토리얼에서는 Node.js가있는 Express Server를 설정하고 자체 API를 구축하여 이러한 모든 이론을 실천하는 방법을 배웁니다.
이 기사는 업데이트되었으며 Jacob Jackson의 기여도가 포함되어 있습니다. Jacob은 웹 개발자, 기술 작가, 프리랜서 및 오픈 소스 기고자입니다.
위 내용은 Node.js 및 Express로 첫 번째 API를 코딩하십시오 : REST API 이해의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!