4.5. API 인증 정보 자동 채우기 ActiveDocs auto-fill of API credentials
API 인증 정보의 자동 채우기는 3scale ActiveDocs의 OAS에 유용한 확장입니다. API 인증 모드에 따라 다음 값을 사용하여 x-data-threescale-name 필드를 정의할 수 있습니다.
-
user_keys: API 키 인증만 사용하는 서비스의 애플리케이션에 대한 사용자 키를 반환합니다. -
app_ids: App ID/App Key를 사용하는 서비스 애플리케이션의 ID를 반환합니다. OAuth 및 OpenID Connect도 이전 버전과의 호환성을 위해 지원됩니다. -
app_keys: 앱 ID/앱 키를 사용하는 서비스 애플리케이션의 키를 반환합니다. OAuth 및 OpenID Connect도 이전 버전과의 호환성을 위해 지원됩니다.
참고
x-data-threescale-name 필드는 ActiveDocs 도메인 외부에서 무시되는 OAS 확장입니다.
API 키 인증 예
다음 예제에서는 API 키 인증에만 "x-data-threescale-name": "user_keys" 를 사용하는 방법을 보여줍니다.
"parameters": [
{
"name": "user_key",
"in": "query",
"description": "Your API access key",
"required": true,
"schema": {
"type": "string"
},
"x-data-threescale-name": "user_keys"
}
]
x-data-threescale-name 으로 선언된 매개변수의 경우 사양에 구성된 값에 따라 5개의 최신 키, 사용자 키, 앱 ID 또는 앱 키가 있는 드롭다운 목록이 표시됩니다. 따라서 값을 복사하여 붙여넣지 않고도 입력을 자동으로 채울 수 있습니다.