엔드포인트 기본 사항
엔드포인트 생성
APIs 모듈 내에서 새 엔드포인트를 생성하려면 New Endpoint 버튼을 클릭하십시오.1.
2.
3.
4.
5.
설계 우선 모드
요청 우선 모드
인터페이스 모드
엔드포인트 경로
/users). 기본 URL은 환경에서 설정되며, Apidog는 엔드포인트에 요청을 보낼 때 이를 자동으로 추가합니다./로 시작할 것도 권장합니다. 이렇게 하면 API 설계가 깔끔하고 체계적으로 유지되며 Apidog 기능의 이점을 온전히 활용할 수 있습니다.경로를 /로 시작해야 하는 이유
/로 시작하는 것은 OAS를 준수하기 위해 권장됩니다. 경로를 /로 시작하지 않으면 OpenAPI 생태계 내의 도구를 사용할 때 다양한 호환성 문제가 발생할 수 있습니다./를 사용하면 Apidog에서 테스트 및 검증 목적에 필수적인 URL 패턴 목 기능을 활용할 수 있습니다.요청 메서드
| 메서드 | 설명 |
|---|---|
| GET | 부작용 없이 지정된 리소스를 가져옵니다. 데이터를 전송하기 위해 쿼리 매개변수를 사용합니다. |
| POST | 처리를 위해 데이터를 제출하며 부작용이 있을 수 있습니다. 데이터는 일반적으로 요청 본문에 전송됩니다. |
| PUT | 지정된 리소스를 전체적으로 업데이트하거나 교체합니다. |
| DELETE | 지정된 리소스를 제거합니다. |
| OPTIONS | 대상 리 소스에서 지원하는 HTTP 메서드에 대해 조회합니다. |
| HEAD | GET과 유사하지만 응답 헤더만 가져옵니다. 리소스 콘텐츠를 다운로드하지 않고 리소스 존재 여부와 수정 여부를 확인하는 데 유용합니다. |
| PATCH | 지정된 리소스의 일부 정보를 업데이트합니다. |
| TRACE | 서버가 수신한 요청을 반환합니다. 주로 디버깅 및 진단 목적으로 사용됩니다. |
| CONNECT | 서버에 대한 터널을 설정하며, 일반적으로 프록시 서버 요청 전달에 사용됩니다. |
엔드포인트 메타데이터
| 필드 | 설명 |
|---|---|
| Name | 엔드포인트의 기능을 설명하는 서술형 이름입니다. |
| Status | 기본 상태는 "Developing"입니다. 이를 Testing 또는 Production과 같은 다양한 단계가 반영되도록 수정할 수 있습니다. Endpoint status에 대해 자세히 알아보십시오. |
| Maintainer | 엔드포인트를 담당하는 Apidog 팀 구성원을 지정합니다. 계정에서 사용자를 선택하여 이 역할을 할당하십시오. |
| Tags | 엔드포인트를 분류하거나 설명하는 키워드 또는 구문입니다. 새 태그를 만들거나 기존 태그 중에서 선택할 수 있습니다. |
| Service | 엔드포인트 경로가 추가되는 기본 URL입니다. 기본적으로 "Inherit from parents"로 설정되지만, 환경 설정을 통해 수동으로 지정할 수 있습니다. Environments and services에 대해 자세히 알아보십시오. |
| OperationId | API 내에서 이 작업을 구분하는 고유 식별자(OAS의 operationId)입니다. |
| Description | 엔드포인트의 목적과 사용법에 대한 자세한 정보이며, 향상된 서식을 위해 Markdown을 지원합니다. |
사용자 지정 필드
요청
요청 매개변수
쿼리 매개변수
? 뒤에 URL 끝에 추가되고 &로 구분되는 키-값 쌍이며, 다음과 같습니다: ?id=2&status=available. 이는 API 엔드포인트의 출력을 필터링, 정렬 또는 수정하는 데 사용됩니다.INFO
경로 매개변수
/pets/{id}, 잘못된 예시: /pets/:id.{parameter}로 정의한 다음 매개변수 값에 {{variable}}을 사용하는 것입니다. 예를 들면 다음과 같습니다.권장: 변수를 경로 매개변수 값에 넣으십시오.
권장하지 않음: 변수를 URL에 직접 넣지 마십시오.
{parameter}와 {{variable}}를 혼동하지 마십시오
{parameter}: 단일 중괄호는 Apidog에서 경 로 매개변수를 나타냅니다. 경로 매개변수는 API 엔드포인트에 액세스할 때 특정 값으로 동적으로 변경되는 URL 경로의 자리 표시자입니다.{{variable}}: 이중 중괄호는 요청 내의 변수를 포함합니다. 이러한 변수는 요청이 전송될 때 실제 값으로 대체될 수 있어 API 상호작용에서 동적이고 사용자 지정 가능한 입력을 허용합니다.경로에서 {{variable}}를 사용하지 말아야 하는 이유
{{variable}}를 사용하는 것은 OAS를 준수하지 않습니다. OAS를 따르면 OpenAPI 생태계 내 다양한 도구와 원활하게 통합할 수 있습니다.{{variable}}를 사용하면 Apidog에서 URL 패턴 목 기능을 사용할 수 없습니다.헤더 매개변수
자세히 알아보기
본문 매개변수
자세히 알아보기
매개변수 설명
| 속성 | 설명 |
|---|---|
| Name | 설명 중인 매개변수의 이름을 지정합니다. 필수 필드이며 정의 중인 매개변수를 정확하게 나타내야 합니다. |
| Type | 매개변수 값의 데이터 유형을 지정합니다. 일반적인 값에는 string, number, integer, boolean, array, object 등이 포함됩니다. 이 속성은 매개변수 값의 형식과 구조를 정의하는 데 도움이 됩니다. |
| Description | 매개변수에 대한 간략한 설명 또는 문서를 제공합니다. 사용자가 매개변수의 목적과 사용법을 이해하는 데 도움이 됩니다. |
| Required | 매개변수가 API 요청에 필수인지 여부를 지정합니다. 이는 매개변수가 요청에 포함되어야 하는지 여부를 나타내는 불리언 값(true 또는 false)입니다. |
| Advanced Settings | 매개변수의 데이터 유형, 형식 및 제약 조건을 정의합니다. 매개변수 값의 예상 구조와 내용에 대한 자세한 정보를 제공할 수 있습니다. |
유형 편집기
스키마
JSON 또는 XML인 경우 데이터 구조를 설정해야 합니다. 데이터 구조는 스키마를 참조할 수 있습니다.자세히 알아보기
응답 및 예시
| 구성 요소 | 설명 |
|---|---|
| HTTP Status Code | 엔드포인트가 반환할 수 있는 모든 잠재적 응답 상태를 결정합니다. 여기에는 200 (OK), 404 (Not Found), 500 (Server Error)와 같은 표준 응답이 포함됩니다. |
| Data Format | API가 각 상태 코드에 대해 반환할 응답 형식을 정의합니다. 이는 JSON, XML, HTML, Raw, Binary 또는 기타 적합한 형식일 수 있습니다. |
| Schema | 데이터를 전달하는 응답(주로 200 상태)의 경우 응답 페이로드의 구조를 자세히 설명합니다. 여기에는 유형, 중첩 객체, 선택 필드 및 배열 지정이 포함됩니다. 명확한 정의는 클라이언트 개발자가 어떤 데이터를 예상해야 하는지, 그리고 이를 어떻게 파싱해야 하는지 이해하는 데 도움이 됩니다. JSON 및 XML만 스키마를 구성할 수 있습니다. 자세한 정보는 Schemas를 참조하십시오. |
| Example | 예시 응답을 제공하는 것은 실제 시나리오에서 API가 어떻게 동작하는지 보여주는 데 필수적입니다. 예시는 미리 정의된 요청으로 엔드포인트를 호출했을 때 서버가 반환하는 샘플 데이터 세트인 것이 이상적입니다. 이는 응답 스키마에 정의된 구조, 데이터 형식 및 유형을 반영해야 합니다. |
응답 추가
200 OK 응답은 고유한 출력 데이터 요구 사항으로 인해 다양한 엔드포인트마다 다른 경우가 많지만, 400 Bad Request 및 404 Not Found와 같은 오류 응답은 서로 다른 엔드포인트 전반에서 일관된 경향이 있습니다. Apidog는 사전 정의된 오류 응답을 재사용할 수 있는 Response Component 기능으로 이러한 공통성을 스마트하게 처리하여 API 문서화 프로세스를 더 효율적으로 만들고 API 동작을 더 일관되게 합니다.응답 구성 요소
응답 예시 추가
자동 예시 생성
엔드포인트 미리보기
Modified at 2026-06-09 08:53:32