Node.js 및 Express로 첫 번째 API를 코딩하십시오 : REST API 이해

휴식과 편안한 API 소개

현대 웹 개발에서는 종종 REST 및 API와 같은 용어를 만나야합니다. 이 용어 나 중고 API에 대해 들어 보았지만 그들이 어떻게 작동하는지 또는 자신의 API를 구축하는 방법을 완전히 이해하지 못하는 경우,이 튜토리얼 시리즈는 귀하에게 적합합니다.

이 튜토리얼 시리즈는 먼저 휴식 원칙과 개념에 대한 개요입니다. 그런 다음 Node.js Express 서버에서 실행되는 완전한 API를 생성하고 MySQL 데이터베이스에 연결됩니다. 이 일련의 튜토리얼을 완료 한 후에는 자신감을 가지고 자신의 API를 구축하거나 기존 API에 대한 문서를 파헤칠 수 있습니다.

전제 조건

이 튜토리얼을 최대한 활용하려면 기본 명령 줄 지식, 기본 JavaScript 지식 및 Node.js를 전 세계적으로 설치해야합니다.

휴식과 편안한 API는 무엇입니까?

선언적 상태 전송 ( REST )은 웹 서비스의 건축 스타일을 설명합니다. REST는 다른 시스템간에 데이터를 공유하기위한 일련의 표준 또는 제약 조건을 포함합니다. REST는 언어, 프레임 워크 또는 소프트웨어 유형이 아닌 추상 개념입니다.

휴식에 대한 느슨한 비유는 비닐 레코드 컬렉션을 유지하고 스트리밍 음악 서비스 사용입니다. 물리적 비닐 레코드 컬렉션의 경우 사본을 공유하고 배포하려면 각 레코드를 전체적으로 복사해야합니다. 그러나 스트리밍 서비스의 경우 노래 제목과 같은 특정 데이터를 참조하여 동일한 음악을 영구적으로 공유 할 수 있습니다. 이 경우 스트리밍 음악은 편안한 서비스이며 Vinyl Record Collection은 재생비가 아닌 서비스입니다.

API 는 애플리케이션 프로그래밍 인터페이스로, 소프트웨어 프로그램이 서로 통신 할 수있는 인터페이스입니다. RESTFUL API는 REST 원칙과 제약을 따르는 API입니다. Web API에서 서버는 URL 엔드 포인트를 통해 요청을 수신하고 응답을 반환합니다.이 응답은 일반적으로 JSON 형식의 데이터입니다.

휴식 원리

6 개의 안내 제약 조건은 나머지 아키텍처를 다음과 같이 정의합니다.

1. 통합 인터페이스 : 구성 요소의 인터페이스는 동일해야합니다. 이는 URI 표준을 사용하여 리소스, 즉 브라우저 주소 표시 줄에 입력 할 수있는 경로를 식별하는 것을 의미합니다.
2. 클라이언트-서버 : 서버 (저장 및 운영 데이터)와 클라이언트 (요청 및 디스플레이 응답)간에 우려 사항이 분리되어 있습니다.
3. 무국적 상호 작용 : 각 요청에 대한 모든 정보는 각 개별 요청에 포함되며 세션 상태에 의존하지 않습니다.
4. 캐시 가능 : 클라이언트와 서버는 리소스를 캐시 할 수 있습니다.
5. 계층 적 시스템 : 클라이언트는 최종 서버 또는로드 밸런서와 같은 중간 계층에 연결할 수 있습니다.
6. 주문형 코드 (선택 사항) : 클라이언트는 코드를 다운로드하여 외부 가시성을 줄일 수 있습니다.

요청 및 응답

HTTPS (안전한 버전)로 시작하는 모든 웹 사이트의 URL에 이미 익숙 할 수 있습니다. 하이퍼 텍스트 전송 프로토콜 ( HTTP )은 인터넷의 클라이언트와 서버 간의 통신 방법입니다.

우리는 가장 분명히 브라우저의 URL 막대에서 볼 수 있지만 HTTP는 서버에서 웹 사이트를 요청하는 데 사용될 수 없습니다. 웹에서 URL에 액세스하면 실제로 GET 및 기타 유형의 요청을 수행하는 것입니다.

HTTP는 서버 포트 (HTTP, HTTPS)에 TCP (Transport Control Protocol) 연결을 열어 요청을 요청하며 청취 서버는 상태와 본문을 반환합니다.

요청에는 URL, 메소드, 헤더 정보 및 본문이 포함되어야합니다.

요청 방법

HTTP 동사라고도하는 4 가지 주요 HTTP 방법은 웹 API와 상호 작용하는 데 일반적으로 사용됩니다. 이러한 방법은 특정 자원에서 수행 할 조치를 정의합니다.

HTTP 요청 방법은 생성, 업데이트, 읽기 및 삭제를 나타내는 CRUD 예제에 대략적으로 일치합니다. CRUD는 데이터베이스 작업에 사용 된 기능을 말하지만 RESTFul API에서 이러한 설계 원칙을 HTTP 동사에 적용 할 수 있습니다.

 <code>curl -i https://www.google.com</code>

Google 서버는 다음을 반환합니다.

 <code>HTTP/2 200 date: Sun, 21 Aug 2022 19:06:22 GMT expires: -1 cache-control: private, max-age=0 content-type: text/html; charset=ISO-8859-1 ...</code>

200 상태 코드와 HTTP 버전을 볼 수 있습니다 (HTTP/1.1, HTTP/2 또는 HTTP/3).

이 특정 요청은 웹 사이트를 반환하기 때문에 텍스트/html입니다. RESTFUL API에서는 Google (Google.com 포함)에 대한 CURL 요청이 301 응답을 반환하여 리소스를 리디렉션해야한다는 것을 나타낼 수 있습니다.

API 엔드 포인트를 휴식하십시오

서버에서 API가 생성되면 포함 된 데이터는 엔드 포인트를 통해 액세스 할 수 있습니다. 엔드 포인트 는 게시, 삭제 요청을 수락하고 처리 할 수있는 URL입니다.

API URL은 루트, 경로 및 선택적 쿼리 문자열로 구성됩니다.

• 예를 들어, root , https://www.php.cn/link/9efa87e164995a7743eca9ad63029fa4 의 루트는 프로토콜, 도메인 이름 및 버전을 포함 할 수 있습니다.
• 경로 예를 들어 /사용자 /5 : 특정 리소스의 유일한 위치.
• 한계 = 10과 같은 쿼리 매개 변수 (선택 사항)는 10 개의 결과 만 포함하도록 응답을 필터링하는 데 사용됩니다.

예를 들어, ID 5가있는 사용자를 얻으려면 /사용자 /5를 사용합니다.

휴식 API 계약

편안한 API를 구축 할 때 따라야 할 규칙은 다음과 같습니다.

• 엔드 포인트에는 파일 확장자가 표시되지 않아야합니다 . API가 JSON을 반환 할 가능성이 높지만 URL은 .json에서 끝나지 않아야합니다.
• 동사 대신 명사를 사용하십시오 . 예를 들어, 사용자를 추가하려면 /사용자 엔드 포인트를 사용하고 /사용자 /추가 엔드 포인트 대신 게시물 요청을 사용해야합니다. API는 여러 유형의 요청을 동일한 URL로 처리 할 수 ​​있도록 개발해야합니다.
• 경로는 사례에 민감하며 밑줄 대신 소문자와 하이픈을 사용해야합니다 . 예를 들어, /user-list는 /user_list보다 바람직합니다.

이 모든 규칙은 따라야 할 엄격한 휴식 기준이 없기 때문에 지침 원칙입니다. 그러나이 가이드 라인을 사용하면 API가 일관되고 친숙하며 읽고 이해하기 쉽습니다.

쉬는 대안

REST는 훌륭한 도구이지만 경우에 따라 도움이되는 몇 가지 대안이 있습니다.

비누

SOAP (Simple Object Access Protocol)는 1998 년에 생성 된 API이며 휴식 전에 매우 인기가있었습니다. 그들 사이에는 몇 가지 주요 차이점이 있습니다. 첫째, SOAP는 응답 형식에 대해 훨씬 엄격한 제한을 가지고 있습니다. 둘째, SOAP는 JSON 대신 XML을 사용하는데, 이는 레거시 애플리케이션에 유용 할 수 있지만 일반적으로 동등한 JSON보다 더 크고 복잡합니다. 마지막으로 SOAP는 HTTP에서 잘 작동하지만 SMTP와 같은 프로토콜도 지원합니다.

그래프 QL

GraphQL은 Facebook에서 생성 한 최신 API 형식으로 클라이언트가 서버에 필요한 데이터를 정확하게 알 수 있도록하여 데이터를 가져 오는 데 필요한 HTTP 요청 수를 줄입니다. GraphQL은 URL 경로를 사용하는 대신 클라이언트가 필요한 데이터를 정의하여 클라이언트가 한 번의 요청에서 필요한 모든 것을 얻을 수 있도록 사용자 정의 구문을 가지고 있습니다.

GraphQL에 대한 훌륭한 소개를 보려면이 GraphQL 자습서를 확인하십시오.

결론적으로

이 기사에서는 휴식과 편안한 API가 무엇인지, HTTP 요청 방법 및 응답 코드 작동 방식, API URL의 구조 및 일반적인 편안한 API 규칙을 배웁니다. 다음 튜토리얼에서는 Node.js가있는 Express Server를 설정하고 자체 API를 구축하여 이러한 모든 이론을 실천하는 방법을 배웁니다.

이 기사는 업데이트되었으며 Jacob Jackson의 기여도가 포함되어 있습니다. Jacob은 웹 개발자, 기술 작가, 프리랜서 및 오픈 소스 기고자입니다.

위 내용은 Node.js 및 Express로 첫 번째 API를 코딩하십시오 : REST API 이해의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!