4.2. OpenAPI 문서 예: Petstore API
원래 소스에서 사양을 읽으려면 OpenAPI 사양을 참조하십시오.
OAS 사이트에는 API를 정의하는 OpenAPI 문서의 여러 예제가 있습니다. 예제로 배우고 싶다면 OAS API 팀에서 Petstore API 예제를 따를 수 있습니다.
Petstore API는 매우 간단한 API입니다. 이는 프로덕션용이 아닌 학습 도구로 사용됩니다.
Petstore API 방법
Petstore API는 다음 4가지 방법으로 구성됩니다.
-
GET /api/pets- 시스템에서 모든 애완동물을 반환합니다. -
POST /api/pets- 저장소에 새 애완동물 생성 -
GET /api/pets/{id}- 단일 ID를 기반으로 ID를 반환합니다. -
DELETE /api/pets/{id}- ID를 기반으로 하나의 애완동물 삭제
Petstore API는 3scale과 통합되어 있으므로 인증을 위해 매개변수를 추가해야 합니다. 예를 들어 사용자 키 인증 방법을 사용하면 API 소비자는 각 요청의 헤더에 user key 매개 변수를 배치해야 합니다. 다른 인증 방법에 대한 자세한 내용은 인증 패턴을 참조하십시오.
사용자 키 매개변수
user_key: {user_key}
user_key 는 API 소비자가 요청에 따라 API로 전송합니다. API 소비자는 3scale 관리자의 개발자 포털을 가져옵니다. 키를 받으면 3scale 관리자는 Service Management API를 사용하여 3scale에 대해 권한 부여 검사를 수행해야 합니다.
OpenAPI 사양에 대한 추가 정보
API 소비자의 경우 cURL 호출에 표시된 API 설명서는 다음과 같습니다.
curl -X GET "http://example.com/api/pets?tags=TAGS&limit=LIMIT" -H "user_key: {user_key}"
curl -X POST "http://example.com/api/pets" -H "user_key: {user_key}" -d "{ "name": "NAME", "tag": "TAG", "id": ID }"
curl -X GET "http://example.com/api/pets/{id}" -H "user_key: {user_key}"
curl -X DELETE "http://example.com/api/pets/{id}" -H "user_key: {user_key}"