웹 API 인터페이스 및 기타 사양에 대한 자세한 설명

웹 API 인터페이스란 무엇인가요?

요청 메소드를 지우고, 해당 백엔드에 필요한 매개변수를 제공하고, 백엔드에서 응답 데이터를 가져오기 위한 URL 링크를 요청합니다.

요청 메소드: get, post, put, patch....

요청 매개변수: json 또는 xml 형식 키-값 유형 데이터

응답 결과: json 또는 xml 형식으로 키-값 유형 데이터를 반환

인터페이스는 어떻게 작성하나요?

특정 규칙(사양)을 참조하여 URL 링크를 작성하고 해당 규칙에 따라 요청 방법, 요청 데이터 및 응답 결과를 공식화합니다.

인터페이스 사양: webapi 인터페이스 사양: restful

RESTful 소개

REST는 기술과 관련이 없으며 소프트웨어 아키텍처 스타일을 나타냅니다. REST는 Representational State Transfer의 약어이며 중국어 번역은 "Representation State Transfer" 또는 "Presentation Layer State Transformation"입니다.

도메인 이름

api 키워드를 사용하여 인터페이스 URL을 식별하세요

https://api.example.com
https://example.org/api/

참고: api라는 단어가 보인다는 것은 요청 URL 링크가 프런트엔드 및 백엔드 데이터 상호 작용을 완료한다는 의미입니다

Version

1. 버전 정보 변경

https://api.example.com/v1/
https://api.example.com/v2/

v1과 같이 URL에 입력하세요. v2는 데이터 리소스에 여러 버전이 있는 경우 다양한 데이터 버전의 철회를 나타냅니다.

2. 버전 정보를 요청 헤더에 입력하세요.

url path

인터넷의 모든 것은 리소스로 간주되며 명사(일반적으로 복수형)로 표시됩니다.

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

URL 링크에서 리소스를 작동하는 동사를 보상하세요.

오류 예: https:/ /api.baidu.com/delete-user

특수 인터페이스에는 일반적으로 명확한 리소스가 없거나 동사가 인터페이스

https://api.baidu.com/place/search
https://api.baidu.com/login

메소드 요청의 핵심 의미이기 때문에 동사가 특수 인터페이스에 나타날 수 있습니다. method

GET: 서버에서 리소스(하나 이상의 항목) 가져오기

POST: 서버에 새 리소스 생성

PUT: 서버에서 리소스 업데이트(클라이언트는 변경 후 전체 리소스 제공)

PATCH: 서버의 리소스 업데이트(클라이언트에서 변경된 속성 제공)

DELETE: 서버에서 리소스 삭제

Filtering

url

https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

Status에 업로드 매개변수 형식으로 검색 조건 전달 code

200 OK - [GET]: 서버가 사용자 요청 데이터를 성공적으로 반환했으며 이 작업은 멱등적입니다.

201 생성됨 - [POST/PUT/PATCH]: 사용자가 데이터를 성공적으로 생성했거나 수정했습니다.

202 승인됨 - [*]: 요청이 백그라운드 대기열에 진입했음을 나타냅니다(비동기 작업).

204 콘텐츠 없음 - [DELETE]: 사용자가 데이터를 성공적으로 삭제했습니다.

301: 영구 리디렉션

302: 임시 리디렉션

400 잘못된 요청 - [POST/PUT/PATCH]: 서버가 데이터를 생성하거나 수정하지 않습니다. 의 멱등성.

401 권한 없음 - [*]: 사용자에게 권한이 없음을 나타냅니다(토큰, 사용자 이름 및 비밀번호가 올바르지 않음).

403 금지됨 - [*] 사용자가 승인되었지만(401 오류와 반대) 액세스가 금지되었음을 나타냅니다.

404 찾을 수 없음 - [*]: 사용자가 실행한 요청은 존재하지 않는 레코드에 대한 것이며 서버가 작업을 수행하지 않았습니다.

406 허용되지 않음 - [GET]: 사용자가 요청한 형식을 사용할 수 없습니다(예: 사용자가 JSON 형식을 요청했지만 XML 형식만 요청함).

410 사라짐 -[GET]: 사용자가 요청한 리소스가 영구적으로 삭제되어 다시 얻을 수 없습니다.

422 처리할 수 없는 엔터티 - [POST/PUT/PATCH] 개체를 생성할 때 유효성 검사 오류가 발생했습니다.

500 내부 서버 오류 - [*]: 서버 오류가 발생하여 사용자는 요청이 성공했는지 확인할 수 없습니다.

오류 처리

상태 코드가 4xx인 경우 오류 정보를 반환해야 하며 오류가 키로 사용됩니다.

{
    error: "Invalid API key"
}

결과 반환

다양한 작업의 경우 서버에서 사용자에게 반환하는 결과는 다음 사양을 준수해야 합니다.

GET /collection: 리소스 개체 목록(배열)을 반환합니다.

GET /collection/resource : 단일 리소스 개체를 반환합니다

POST /collection: 새로 생성된 리소스 개체를 반환합니다

PUT /collection/resource: 전체 리소스 개체를 반환합니다

PATCH /collection/resource: 전체 리소스 개체를 반환합니다

DELETE /collection/ 리소스: 빈 문서를 반환합니다

{
    "status": 0,
    "msg": "ok",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
        ...
        ]
}

Hypermedia API

RESTful API는 하이퍼미디어가 가장 좋습니다. 즉, 반환된 결과에 다른 API 메서드에 대한 링크를 제공하므로 사용자는 문서를 확인하지 않고도 다음에 수행할 작업을 알 수 있습니다.

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

PHP 관련 지식을 더 보려면 PHP 중국어 웹사이트를 방문하세요!

위 내용은 웹 API 인터페이스 및 기타 사양에 대한 자세한 설명의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!