REST API 디자인 원칙은 무엇입니까?

REST API 설계 원칙에는 리소스 정의, URI 설계, HTTP 방법 사용, 상태 코드 사용, 버전 제어 및 증오가 포함됩니다. 1. 자원은 명사로 표현되어야하며 계층 구조로 유지해야합니다. 2. HTTP 방법은 Get이 자원을 얻는 데 사용되는 것과 같은 의미론을 준수해야합니다. 3. 404와 같이 상태 코드는 올바르게 사용해야합니다. 자원이 존재하지 않음을 의미합니다. 4. 버전 제어는 URI 또는 ​​헤더를 통해 구현할 수 있습니다. 5. 증오는 응답으로 링크를 통한 클라이언트 작업을 부팅합니다.

소개

REST API Design Principles, 이것은 수많은 개발자들이 좋아하고 싫어하는 주제입니다. 왜 그렇게 말합니까? REST API는 현대 웹 개발의 모든 곳에 있기 때문에 디자인 원칙은 단순하고 복잡하기 때문에 모든 사람이 시작할 수 있도록 단순하기 때문에 선임 개발자도 깊은 생각에 빠질 수 있습니다. 오늘 우리는 REST API의 디자인에 대해 이야기 할 것입니다. 말을 한 후에는 우아하고 실용적인 REST API를 설계하는 방법에 대해 더 깊이 이해할 수 있습니다.

휴식의 기본 개념

REST, 성명 상태 전송은 네트워크 애플리케이션을 설계하는 데 사용되는 건축 스타일입니다. Roy Fielding은 2000 년 에이 개념을 제안했으며, 핵심 아이디어는 HTTP 프로토콜을 통해 리소스 운영을 구현하는 것입니다. 간단히 말해서, REST는 모든 컨텐츠를 리소스로 취급하고 각 리소스는 고유 한 URI에 의해 식별되며 HTTP 방법 (예 : Get, Post, Put, Delete)을 통해 리소스에서 작동합니다.

예를 들어, 블로그 게시물을 리소스로 간주 할 수있는 블로그 시스템이 있다고 가정하면 특정 게시물을 얻기위한 API를 다음과 같이 설계 할 수 있습니다.

 get /articles /{articleid}

이것은 URI를 통해 특정 ID가있는 기사를 받으려는 간단한 GET 요청입니다.

REST API 디자인 원칙의 핵심

리소스 정의 및 URI 디자인

나머지 API에서 리소스가 핵심 개념입니다. 각 리소스에는이를 식별하기 위해 고유 한 URI가 있어야합니다. URI를 설계 할 때는 몇 가지 원칙을 따라야합니다.

• 동사 대신 명사를 사용하십시오 . URI는 작업이 아닌 자원 자체를 나타냅니다. 예를 들어, /users /getUsers 대신 사용해야합니다.
• 계층 구조 유지 : URI는 자원 간의 관계를 반영해야합니다. 예를 들어, 사용자의 기사는 /users/{userId}/articles 로 표시 될 수 있습니다.

우수한 URI 디자인은 API를 쉽게 이해할 수있을뿐만 아니라 유지 관리가 더 쉬워집니다. 예를 들어, 특정 사용자의 모든 기사를 얻으려면 다음과 같이 설계 할 수 있습니다.

 get/user/{userId}/articles

HTTP 방법의 사용

HTTP 방법은 나머지 API의 또 다른 핵심입니다. 각 방법에는 고유 한 의미가 있습니다.

• GET : 자원을 얻는 데 사용됩니다
• 게시물 : 새로운 리소스를 만드는 데 사용됩니다
• PIT : 리소스를 업데이트하는 데 사용됩니다
• 삭제 : 리소스를 삭제하는 데 사용됩니다

이 방법을 사용하는 경우 HTTP 사양을 준수해야합니다. 예를 들어, GET 요청은 idempotent입니다. 즉, 여러 통화는 리소스의 상태를 변경하지 않습니다.

상태 코드 사용

HTTP 상태 코드는 REST API가 클라이언트와 통신하는 중요한 수단입니다. 일반적인 상태 코드는 다음과 같습니다.

• 200 OK : 요청이 성공했습니다
• 201 생성 : 자원 생성이 성공적입니다
• 400 불량 요청 : 요청이 유효하지 않습니다
• 404 찾기 : 자원이 존재하지 않습니다
• 500 내부 서버 오류 : 내부 서버 오류

상태 코드를 올바르게 사용하면 클라이언트가 API의 응답을보다 쉽게 ​​이해할 수 있습니다. 예를 들어, 사용자가 존재하지 않는 리소스를 요청하면 404 상태 코드가 반환됩니다.

 get /articles /9999
http/1.1 404는 찾을 수 없습니다

버전 제어

API의 버전 작성은 REST 디자인의 중요한 측면입니다. API는 시간이 지남에 따라 변경 될 수 있으며 기존 클라이언트에 영향을 미치지 않고 이러한 변경 사항을 처리하는 방법은 어려운 일입니다. 일반적인 버전 제어 방법은 다음과 같습니다.

• URI 버전 제어 : 예를 들어 /v1/users
• 헤더 버전 제어 : Accept: application/vnd.myapp.v1 json 과 같은 사용자 정의 헤더 사용

나는 고객이 더 직관적이고 고객이 이해하고 사용하기가 더 쉽기 때문에 개인적으로 선호합니다.

응용 프로그램 상태의 엔진으로서 하이퍼 미디어 (증오)

증오 도아는 REST의 고급 기능으로 API가 클라이언트를 다음 단계로 안내 할 수 있습니다. 예를 들어, 사용자 목록을 얻을 때 응답에는 각 사용자에 대한 링크가 포함될 수 있습니다.

 {
  "사용자": [
    {
      "ID": 1,
      "이름": "John Doe",
      "링크": [
        {
          "rel": "self",
          "href": "/user/1"
        }
      ]]
    }
  ]]
}

증오 도아는 API를보다 자체적으로 설명 할 수 있으며 고객은 응답의 링크를 기반으로 API를 동적으로 발견하고 사용할 수 있습니다. 그러나 증오 도아를 구현하면 API의 복잡성이 증가 하고이 기능이 실제로 필요한지 여부에 관계없이 상충이 필요합니다.

사용의 예

기본 사용

간단한 REST API 예제를 살펴 보겠습니다. 라이브러리 관리 시스템을 설계하고 싶다고 가정 해 봅시다.

 가져 오기 /책

이것은 모든 책의 목록을 반환합니다.

 [의 뜻
  {
    "ID": 1,
    "제목": "그레이트 개츠비",
    "저자": "F. Scott Fitzgerald"
  },
  {
    "ID": 2,
    "제목": "모킹 버드를 죽이기",
    "저자": "하퍼 리"
  }
]]

고급 사용

이제 더 복잡한 예를 살펴 보겠습니다. 책의 검색 기능을 구현하고 싶다고 가정 해 봅시다.

 GET /BOOKS? TITLE = Great Gatsby

이것은 "The Great Gatsby"라는 제목으로 책을 반환합니다.

 [의 뜻
  {
    "ID": 1,
    "제목": "그레이트 개츠비",
    "저자": "F. Scott Fitzgerald"
  }
]]

일반적인 오류 및 디버깅 팁

REST API를 설계 할 때의 일반적인 오류는 다음과 같습니다.

• URI 디자인은 일관성이 없습니다 . 예를 들어, 때때로 /users/{userId} 사용하고 때로는 /user/{userId} 사용하여 API를 혼란스럽게 만듭니다.
• 오류 상태 코드 : 예를 들어, 리소스가 존재하지 않으면 404 대신 500을 반환하여 클라이언트가 오류를 처리하기가 어렵습니다.

이러한 문제를 디버깅하는 방법은 다음과 같습니다.

• Swagger 또는 Postman과 같은 API 문서 도구를 사용하면 API의 정확성을 테스트하고 확인하는 데 도움이 될 수 있습니다.
• 로깅 : 서버 측의 자세한 로그를 기록하여 문제를 추적하고 해결하는 데 도움이됩니다.

성능 최적화 및 모범 사례

실제 응용 분야에서 REST API의 성능을 최적화하는 방법은 중요한 주제입니다. 몇 가지 최적화 제안은 다음과 같습니다.

• 캐시 : HTTP를 사용하여 Cache-Control 및 ETag 와 같은 헤더를 사용하여 불필요한 요청을 줄입니다.
• 페이징 : 많은 양의 데이터를 반환하는 API의 경우 페이징을 사용하면 단일 요청에서 데이터 양을 줄이고 응답 속도를 향상시킬 수 있습니다. 예를 들어:

 get /books? page = 1 & size = 10

• 비동기 처리 : 시간이 많이 걸리는 작업의 경우 비동기 처리를 사용하여 API의 응답 속도를 향상시킬 수 있습니다.

REST API를 작성할 때 주목할 모범 사례가 있습니다.

• 코드 가독성 : 명확한 명명 및 주석을 사용하여 코드를 쉽게 이해하고 유지 관리 할 수 ​​있도록합니다.
• 보안 : HTTPS를 사용하여 데이터 전송의 보안을 보장합니다. OAUTH 또는 JWT를 사용하여 인증 및 승인을 얻으십시오.
• 테스트 : API의 정확성과 안정성을 보장하기 위해 자동 테스트를 작성하십시오.

요약

나머지 API 디자인 원칙은 간단 해 보일 수 있지만 우아하고 실용적인 API를 설계하려면 신중한 고려가 필요합니다. 리소스 정의, URI 설계, HTTP 방법 및 상태 코드 사용, 버전 제어 및 증오에 이르기까지 모든 링크는 신중하게 고려해야합니다. 이 기사의 소개와 예를 통해 REST API를 설계하고 일반적인 실수를 피하고 API의 성능과 유용성을 향상시킬 때 더 많은 생각과 관행을 가질 수 있기를 바랍니다.

위 내용은 REST API 디자인 원칙은 무엇입니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!