281.2. 옵션
REST Swagger 구성 요소는 아래에 나열된 9 가지 옵션을 지원합니다.
| 이름 | 설명 | 기본 | 유형 |
|---|---|---|---|
| basePath (producer) | API basePath(예: /v2). 설정이 설정되지 않은 경우 Swagger 사양에 있는 값을 덮어씁니다. | 문자열 | |
| componentName (producer) | 요청을 수행할 Camel 구성 요소의 이름입니다. compnent는 Camel 레지스트리에 있어야 하며 RestProducerFactory 서비스 공급자 인터페이스를 구현해야 합니다. 설정되지 않은 경우 CLASSPATH 가 RestProducerFactory SPI를 구현하는 단일 구성 요소를 검색합니다. 끝점 구성에서 재정의할 수 있습니다. | 문자열 | |
| 소비 (producer) | 이 구성 요소를 사용할 수 있는 페이로드 유형은 무엇입니까. RFC7231에 따라 application/json 또는 application/json, application/xml, q=0.5와 같은 하나의 유형일 수 있습니다. 이는 Accept HTTP 헤더의 값과 동일합니다. 설정된 경우 Swagger 사양에 있는 모든 값을 덮어씁니다. 끝점 구성에서 재정의할 수 있음 | 문자열 | |
| 호스트 (producer) | 스키마 호스트 이름 및 포트: HTTP 요청을 https://hostname:port 형식으로 보냅니다. 는 Camel 컨텍스트의 엔드포인트, 구성 요소 또는 correspoding REST 구성에서 구성할 수 있습니다. 이 구성 요소에 REST 구성이 먼저 참조되는 이름(예: petstore)을 지정하면 다음에 rest-swagger 및 글로벌 구성이 마지막으로 표시됩니다. 설정된 경우 Swagger 사양에 있는 모든 값을 덮어씁니다. 끝점 구성에서 재정의할 수 있습니다. | 문자열 | |
| 생성 (producer) | 이 구성 요소를 생성하는 페이로드 유형은 무엇입니까. 예를 들면 RFC7231에 따른 application/json입니다. 이는 Content-Type HTTP 헤더의 값과 동일합니다. 설정된 경우 Swagger 사양에 있는 모든 값을 덮어씁니다. 끝점 구성에서 재정의할 수 있습니다. | 문자열 | |
| specificationUri (producer) | Swagger 사양 파일의 경로입니다. 스키마, 호스트 기본 경로는 이 사양에서 가져오지만 구성 요소 또는 엔드포인트 수준의 속성으로 재정의될 수 있습니다. 구성 요소가 제공되지 않는 경우 swagger.json 리소스를 로드하려고 합니다. 이 구성 요소의 구성 요소 및 끝점에 정의된 호스트에는 스키마, 호스트 이름 및 선택적으로 URI 구문의 포트(예: https://api.example.com:8080)가 포함되어야 합니다. 끝점 구성에서 재정의할 수 있습니다. | swagger.json | URI |
| sslContextParameters (보안) | 구성 요소에서 사용하는 TLS 매개변수를 사용자 지정합니다. Camel 컨텍스트에 설정된 TLS 매개변수가 기본값을 설정하지 않는 경우 | SSLContextParameters | |
| useGlobalSslContext Parameters (보안) | 글로벌 SSL 컨텍스트 매개 변수를 사용합니다. | false | boolean |
| resolveProperty Placeholders (advanced) | 구성 요소 시작 시 속성 자리 표시자를 자체적으로 확인해야 하는지 여부입니다. String 유형의 속성만 속성 자리 표시자를 사용할 수 있습니다. | true | boolean |
REST Swagger 엔드포인트는 URI 구문을 사용하여 구성됩니다.
rest-swagger:specificationUri#operationId
다음 경로 및 쿼리 매개변수를 사용합니다.
281.2.1. 경로 매개변수 (2 매개변수):
| 이름 | 설명 | 기본 | 유형 |
|---|---|---|---|
| specificationUri | Swagger 사양 파일의 경로입니다. 스키마, 호스트 기본 경로는 이 사양에서 가져오지만 구성 요소 또는 엔드포인트 수준의 속성으로 재정의될 수 있습니다. 구성 요소가 제공되지 않는 경우 swagger.json 리소스를 로드하려고 합니다. 이 구성 요소의 구성 요소 및 끝점에 정의된 호스트에는 스키마, 호스트 이름 및 선택적으로 URI 구문의 포트(예: https://api.example.com:8080)가 포함되어야 합니다. 구성 요소 구성을 덮어씁니다. | swagger.json | URI |
| operationId | Swagger 사양에서 필요한 작업 ID입니다. | 문자열 |
281.2.2. 쿼리 매개변수 (6 매개변수):
| 이름 | 설명 | 기본 | 유형 |
|---|---|---|---|
| basePath (producer) | API basePath(예: /v2). 설정이 설정되지 않은 경우 Swagger 사양 및 구성 요소 구성에 있는 값을 덮어씁니다. | 문자열 | |
| componentName (producer) | 요청을 수행할 Camel 구성 요소의 이름입니다. compnent는 Camel 레지스트리에 있어야 하며 RestProducerFactory 서비스 공급자 인터페이스를 구현해야 합니다. 설정되지 않은 경우 CLASSPATH 가 RestProducerFactory SPI를 구현하는 단일 구성 요소를 검색합니다. 구성 요소 구성을 덮어씁니다. | 문자열 | |
| 소비 (producer) | 이 구성 요소를 사용할 수 있는 페이로드 유형은 무엇입니까. RFC7231에 따라 application/json 또는 application/json, application/xml, q=0.5와 같은 하나의 유형일 수 있습니다. 이는 Accept HTTP 헤더의 값과 동일합니다. 설정된 경우 Swagger 사양 및 구성 요소 구성에 있는 모든 값을 덮어씁니다. | 문자열 | |
| 호스트 (producer) | 스키마 호스트 이름 및 포트: HTTP 요청을 https://hostname:port 형식으로 보냅니다. 는 Camel 컨텍스트의 엔드포인트, 구성 요소 또는 correspoding REST 구성에서 구성할 수 있습니다. 이 구성 요소에 REST 구성이 먼저 참조되는 이름(예: petstore)을 지정하면 다음에 rest-swagger 및 글로벌 구성이 마지막으로 표시됩니다. 설정된 경우 Swagger 사양에 있는 모든 값을 덮어씁니다. 다른 모든 구성을 재정의합니다. | 문자열 | |
| 생성 (producer) | 이 구성 요소를 생성하는 페이로드 유형은 무엇입니까. 예를 들면 RFC7231에 따른 application/json입니다. 이는 Content-Type HTTP 헤더의 값과 동일합니다. 설정된 경우 Swagger 사양에 있는 모든 값을 덮어씁니다. 다른 모든 구성을 재정의합니다. | 문자열 | |
| 동기 (고급) | 동기 처리를 엄격하게 사용해야 하는지 또는 Camel이 비동기 처리를 사용할 수 있는지 여부를 설정합니다(지원되는 경우). | false | boolean |
