처음부터 REST API를 구축하십시오 : 구현

이 튜토리얼의 첫 번째 부분은 API의 기초 계층 인 서버 설정, 인증, JSON 처리, 오류 관리 및 초기 경로를 설정했습니다. 결정적으로, 우리는 readme에서 자원과 행동을 정의했습니다. 이제 해당 리소스를 구현 하여이 기초를 기반으로하겠습니다.

주요 개념 :

RESTFUL 모범 사례 :

작업 생성 및 업데이트 리소스 리소스 표현. 강력한 ORM/모델 및 유효성 검사 라이브러리는 생산 응용 프로그램에 필수적입니다. 오류 처리 및 유효성 검사 : 엄격한 오류 처리 및 유효성 검사는 데이터 무결성과 적절한 응답을 보장합니다. 여기에는 필수 필드 (예 : 이름과 같은) 및 고유 한 이메일 수표가 포함됩니다.

고급 쿼리 :

효율적인 데이터 검색 및 개선 된 클라이언트 측 성능을위한 필터링, 정렬 및 페이지 매김 구현. 캐싱 : 최적화 된 응답 시간 및 서버로드 감소를 위해 미들웨어와 함께 ETAG 및 서버 측 캐싱 (예 : APC)을 활용합니다. 요금 제한 :
• 미들웨어 기반 요금 제한은 API 과용으로부터 보호하여 가용성과 신뢰성을 보장합니다. 향후 개선 사항 : 고급 ORM/모델 솔루션, 외부 검증 라이브러리 및 APC 이외의 대체 스토리지 옵션을 고려하여 확장 성 계획. 연락처 관리 : 생성 및 업데이트
연락처 생성부터 시작하여 레스트 모범 사례는 생성 또는 업데이트 후 리소스 표현을 반환하는 것을 결정합니다. 이 예제의 데이터베이스 상호 작용은 명확성을 위해 단순화되지만 생산 API는보다 강력한 ORM/모델 및 유효성 검사 라이브러리를 활용합니다.
• 이 게시물 엔드 포인트는 요청 본문을 처리하고, 데이터를 검증하고, 연락처 레코드를 작성하고, 관련 메모를 처리하고, 생성 된 연락처의 JSON 표현을 반환합니다. 업데이트 작업 ( 및 )은 유사한 패턴을 따르고 처리하기 전에 접촉 및 메모를 확인하십시오. 및 메소드는 효율성을 위해 동일한 코드에 매핑됩니다. 접점 목록 및 필터링 기본 연락처 목록은 간단합니다
그러나 그러나 강력한 API는 고급 쿼리를 지원합니다.
• 이 예제는 또는 를 사용하여 또는 를 사용하고 특정 필드를 선택하는 필터링을 보여줍니다. 구현에는 입력을 소독하고 데이터베이스 쿼리를 동적으로 구축하는 것이 포함됩니다.

  $app->post(
  '/contacts',
  function () use ($app, $log) {
      $body = $app->request()->getBody();
      $errors = $app->validateContact($body);
  
      if (empty($errors)) {
          $contact = \ORM::for_table('contacts')->create();
  
          if (isset($body['notes'])) {
              $notes = $body['notes'];
              unset($body['notes']);
          }
  
          $contact->set($body);
  
          if ($contact->save()) {
              if (!empty($notes)) {
                  $contactNotes = [];
                  foreach ($notes as $item) {
                      $item['contact_id'] = $contact->id;
                      $note = \ORM::for_table('notes')->create();
                      $note->set($item);
                      if ($note->save()) {
                          $contactNotes[] = $note->asArray();
                      }
                  }
              }
  
              $output = $contact->asArray();
              if (!empty($contactNotes)) {
                  $output['notes'] = $contactNotes;
              }
              echo json_encode($output, JSON_PRETTY_PRINT);
          } else {
              throw new Exception("Unable to save contact");
          }
      } else {
          throw new ValidationException("Invalid data", 0, $errors);
      }
  }
  );

  이 섹션은 , , , 매개 변수를 처리하고 쿼리 구축 및

  헤더 생성을 포함하여 페이지 매김 관리를위한 세부 코드가 포함됩니다. fields 연락처 세부 정보 및 임베디드 리소스 sort 개별 연락처 세부 정보를 검색하는 것은 간단합니다 page 효율성을 향상시키기 위해 와 같은 쿼리 매개 변수를 사용하여 임베디드 리소스 (예 : 메모)를 가져올 수 있습니다. 매개 변수가있는 경우 참고에 대한 추가 쿼리를 포함하도록 코드가 수정됩니다. 캐싱 및 속도 제한 per_page 캐싱 및 속도 제한은 미들웨어를 사용하여 구현되어 성능 향상 및 API 보호를 제공합니다. 미들웨어 코드 (캐싱 및 요금 제한 모두)는 원래 예제, 캐시 히트/미스, ETAG 생성, 만료 및 적절한 HTTP 헤더를 포함하여 요율 제한 점검을 처리하는 원래 예제와 유사합니다. Link 추가 개발

  이 강화 된 API는 탄탄한 기초를 제공합니다. 향후 개선 사항에는보다 강력한 ORM/모델로 마이그레이션, 전용 검증 라이브러리 통합, 대체 스토리지 솔루션 탐색, API 발견 (예 : Swagger) 구현 및 포괄적 인 테스트 스위트 생성이 포함됩니다. 완전한 소스 코드 (원본에 언급 된 바와 같이)는 전체 구현 세부 정보를 제공합니다.

위 내용은 처음부터 REST API를 구축하십시오 : 구현의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!