방법 시도 및 결과 해석
API Explorer를 사용하여 다양한 방법을 테스트할 수 있습니다. 이 주제에서는 일반적인 프로세스와 시스템에서 반환하는 응답에 대해 설명합니다. 특정 방법 관련 기술에 대해서는 각 방법 유형에 관한 주제를 참조하십시오.
각 방법/리소스의 Try It Out!(시도) 버튼은 시스템과 직접 상호 작용합니다. GET은 실제 데이터를 검색하고, POST/PUT은 실제 리소스를 생성하거나 수정하며, DELETE는 실제 개체를 제거합니다. 변경 사항이 즉시 구축되지는 않지만 이는 시스템에서 실제 컨피그레이션을 변경하는 것입니다. 변경 사항을 실제로 적용하려면 POST /operational/deploy 리소스를 사용하여 구축 작업을 시작합니다.
Try It Out!(시도) 버튼은 방법/리소스를 열면 Response Message(응답 메시지) 섹션 다음에 있습니다. 일부 방법/리소스는 테스트하려면 개체 ID를 입력해야 합니다. 이 경우 일반적으로 먼저 상위 리소스에서 GET을 수행해야 합니다. 자세한 내용은 개체 ID(objId) 및 상위 ID 찾기의 내용을 참고하십시오.
POST/PUT의 경우 JSON 모델의 필수 값을 입력해야 합니다.
Try It Out!(시도)을 클릭하면 API Explorer에서 이 버튼 다음에 나오는 페이지에 결과를 추가합니다. 응답은 다음과 같은 섹션으로 구성되어 있습니다.
- Curl
-
호출하는 데 사용한 curl 명령. 예를 들어 GET /object/networks 리소스에서 Try It Out!(시도)을 클릭하면 다음과 같은 결과가 반환됩니다. 경로의 "v" 요소는 API의 각 새 버전과 함께 변경됩니다.
curl -X GET --header 'Accept: application/json' 'https://ftd.example.com/api/fdm/최신/object/networks'
참고
여기에는 클라이언트에서 API 호출 시 필요한 Authorization: Bearer(권한 부여: 전달자) 헤더가 포함되어 있지 않습니다.
- 요청 URL
-
요청을 수행하기 위해 클라이언트에서 발행하는 URL입니다. 예를 들어, GET /object/networks의 경우 다음과 같습니다.
https://ftd.example.com/api/fdm/최신/object/networks - 응답 본문
-
시스템이 클라이언트에게 반환하는 개체입니다. 리소스에 /object/network와 같은 개체가 여러 개 포함될 수 있는 경우, GET 요청으로 항목 목록을 가져옵니다. POST/PUT/DELETE 응답은 단일 개체에 대한 것입니다.
반환되는 특정 콘텐츠는 리소스 모델을 기반으로 합니다. 예를 들어, GET /object/networks는 개체 목록을 반환하며 각 개체는 다음과 유사하게 표시됩니다(항목 목록의 초기 지표도 표시됨). links/self 값은 이 개체를 참조하기 위해 사용하는 URL을 나타내며, 개체 ID는 URL에 포함되어 있습니다.
{ "items": [ { "version": "900f8558-7d19-11e7-bf7b-3dcaf0c58345", "name": "AIM_SERVERS-205.188.1.132", "description": null, "subType": "HOST", "value": "205.188.1.132", "isSystemDefined": true, "id": "900fac69-7d19-11e7-bf7b-d9417b20e59e", "type": "networkobject", "links": { "self": "https://ftd.example.com/api/fdm/최신/ object/networks/900fac69-7d19-11e7-bf7b-d9417b20e59e" } },GET 요청에는 페이징 섹션도 포함되어 있습니다(GET: 시스템에서 데이터 획득에 설명되어 있음).
- 응답 코드
-
숫자 HTTP 상태 코드는 HTTP 호출에 대해 반환됩니다. 이는 표준 HTTP 상태 코드이며 RFC 또는 Wikipedia에서 찾을 수 있습니다(예: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). 예를 들어, 200(OK)은 성공적인 GET/PUT/POST 호출을 나타내며 204는 성공적인 DELETE 호출을 나타냅니다.
- 응답 헤더
-
이는 HTTP 응답의 패킷 헤더입니다. 예를 들어, GET /object/networks에는 다음과 같은 헤더가 있을 수 있습니다.
{ "date": "Thu, 10 Aug 2017 19:19:16 GMT", "content-encoding": "gzip", "x-content-type-options": "nosniff", "transfer-encoding": "chunked", "connection": "Keep-Alive", "vary": "Accept-Encoding", "x-xss-protection": "1; mode=block", "pragma": "no-cache", "server": "Apache", "x-frame-options": "SAMEORIGIN", "strict-transport-security": "max-age=31536000 ; includeSubDomains", "content-type": "application/json;charset=UTF-8", "cache-control": "no-cache, no-store, max-age=0, must-revalidate", "accept-ranges": "bytes", "keep-alive": "timeout=5, max=99", "expires": "0" }
피드백