프론트엔드와 백엔드 커뮤니케이션에서는 이러한 핵심 지식 포인트를 마스터해야 합니다!

쉼이란 무엇인가요?

restful은 현재 가장 인기 있는 인터페이스 디자인 사양입니다. 프론트엔드와 백엔드 모두가 알아야 할 사양입니다.
이 사양은 인터페이스 개발의 각 프로세스에서

프로토콜을 정의합니다. 클라이언트는 API를 통해 백엔드와 상호 작용합니다. 최종 서비스 통신 과정에서 HTTPS 프로토콜을 사용해야 합니다.

도메인 이름

API는 전용 도메인 이름으로 배포되어야 하며 최대한 단순하게 유지되어야 합니다. API가 매우 간단하고 더 이상 확장되지 않을 것이라고 확신하는 경우 기본 도메인 이름 아래에 배치하는 것을 고려할 수 있습니다. 다음은 두 가지 일반적인 URL 루트 예입니다.

api.example.com/* 별도의 하위 도메인 이름 인터페이스에 액세스하는 데 사용됩니다

example.com/api/* 기본 도메인 이름 아래에 별도의 공간
• 버전 관리

모든 API는 이전 버전과 호환되는 동시에 새 버전의 API를 도입해야 합니다. 의 API를 계속 사용할 수 있습니다. 따라서 버전 지원이 제공되어야 합니다

주소(경로) Router

API 특정 URL

URL의 이름은 모두 소문자여야 합니다.

URL의 리소스(resource) 이름은 다음과 같아야 합니다. 명사, 필수 복수형입니다
• Restful 유형의 URL을 먼저 사용해야 합니다
• URL은 읽기 쉬워야 합니다
• URL은 서버 아키텍처를 노출해서는 안 됩니다.
• URL에 하이픈(-)을 사용해야 하는지 여부 또는 밑줄(_)은 필수는 아니지만 팀 상황에 따라 스타일을 통일해야 합니다

https://api.example.com/zoos

https://api.example.com/ 동물
• https://api.example.com /zoos/{zoo}/animals
• https://api.example.com/animal_types
• https://api.example.com/employees
• 리소스에 대한 동사(요청 메서드 메서드)

HTTP 동사로 표시되는 특정 작업 유형입니다. 일반적으로 사용되는 5개의 HTTP 동사가 있습니다(해당 SQL 명령은 괄호 안에 있음).

GET(SELECT): 서버에서 하나 이상의 리소스를 가져옵니다.

POST(CREATE): 서버에 새 리소스를 생성합니다.
• PUT(UPDATE): 서버의 리소스를 업데이트합니다(클라이언트는 변경된 전체 리소스를 제공합니다).
• PATCH(UPDATE): 서버 업데이트 리소스(클라이언트가 변경된 속성 제공) 부분에서 업데이트합니다.
• DELETE (DELETE): 서버에서 리소스를 삭제합니다.
• url 매개변수

모든 URL 매개변수는 모두 소문자여야 하며 밑줄 유형 매개변수 형식을 사용해야 합니다.Paging 매개변수는 페이지로 고정되어야 하며, page_size

Response(Response)

적절한 HTTP 상태를 선택해야 합니다. 코드. JSON 형식 데이터를 반환해야 합니다.

모든 오류는 동일한 오류 형식이어야 합니다.

공통 상태 코드

1xx는 요청이 승인되었으며 계속 처리해야 함을 의미합니다.

2xx 요청이 성공했으며 응답 헤더 또는 데이터 본문이 예상됩니다. 요청에 의해 이 응답이 반환됩니다
• 200 서버가 사용자가 요청한 데이터를 성공적으로 반환했습니다
• 201 사용자가 데이터를 성공적으로 생성하거나 수정했습니다
  • 202 요청이 백그라운드에서 대기 중임을 나타냅니다(반환이 없음). 성공한 경우 값은 비동기입니다.)
  • 204 삭제 성공
  • 3xx 리디렉션
4xx 클라이언트 사유로 인한 오류
• 404 요청한 인터페이스가 존재하지 않습니다. 오류 유형(요청 주소가 잘못되었습니다.)
• 401 사용자가 로그인되어 있지 않습니다
  • 403 사용자가 로그인되어 있지만 액세스 권한이 없습니다
  • 422 클라이언트 매개 변수가 잘못되었습니다. 확인 오류
  • 429 요청 제한 초과
  • 5xx 서버 측 오류로 인해 발생했습니다. 이유
500 서버에 예상치 못한 상황이 발생하여 요청 처리를 완료할 수 없으며 서버 코드에서 오류를 보고했습니다.
• 503 서버 유지 관리
  • 504 시간 초과 호출
잘못 format

'message' => ':message',          // 错误的具体描述
'errors' => ':errors',            // 参数的具体错误描述，422 等状态提供
'code' => ':code',                // 业务自定义的异常码
'status_code' => ':status_code',  // http状态码
'debug' => ':debug',              // debug 信息，非生产环境提供

메시지란 무엇인가요?

HTTP 메시지는 HTTP 요청 및 응답 시 정보를 교환하는 데 사용됩니다. 메시지는 클라이언트에서 서버로 전달됩니다. 메시지는 요청 메시지와 응답 메시지의 두 가지 범주로 나누어집니다. 요청 메시지와 응답 메시지의 기본 메시지 구조는 동일하며 다음 세 부분으로 구성됩니다.

시작 라인: 설명 message

Header: 일부 속성

Body: Data [선택 사항]

• axios
• 브라우저 및 노드 서버와 호환 가능
브라우저에서 XMLHttpRequest 생성

node.js http 요청에서 생성

Promise API 지원 지원 요청 및 응답 차단

요청 데이터 및 응답 데이터 변환

요청 취소
JSON 데이터 자동 변환
클라이언트는 XSRF에 대한 방어를 지원합니다

어서, 낯선 사람들이여! 도움이 됩니다)

위 내용은 프론트엔드와 백엔드 커뮤니케이션에서는 이러한 핵심 지식 포인트를 마스터해야 합니다!의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!