4.2. OpenAPI 문서 예: Petstore API

원본 소스의 사양을 읽으려면 OpenAPI 사양 을 참조하십시오.

OAS 사이트에는 API를 정의하는 OpenAPI 문서의 여러 예제가 있습니다. 예를 들어 학습하려면 OAS API 팀의 Petstore API 예제를 따를 수 있습니다.

Petstore API는 매우 간단한 API입니다. 이는 생산이 아닌 학습 도구로 사용됩니다.

Petstore API는 3scale과 통합되므로 인증을 위해 매개변수를 추가해야 합니다. 예를 들어 사용자 키 인증 방법을 사용하면 API 소비자에서 user 키 매개 변수를 각 요청의 헤더에 배치해야 합니다. 다른 인증 방법에 대한 자세한 내용은 인증 패턴을 참조하십시오.

user_key 는 API 소비자가 API에 대한 요청으로 전송됩니다. API 소비자는 3scale 관리자의 개발자 포털을 통해 해당 키를 가져옵니다. 키를 수신할 때 3scale 관리자는 Service Management API를 사용하여 3scale에 대한 권한 부여 검사를 수행해야 합니다.

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}"