검색

278.2. 옵션

download PDF

REST Swagger 구성 요소는 아래 나열된 7 가지 옵션을 지원합니다.

이름설명기본값유형

basePath (producer)

API basePath(예: /v2). 기본값은 설정되지 않은 경우, 설정된 경우 Swagger 사양에 있는 값을 재정의합니다.

 

문자열

componentName (producer)

요청을 수행할 Camel 구성 요소의 이름입니다. Camel 레지스트리에 compnent가 있어야 하며 RestProducerFactory 서비스 공급자 인터페이스를 구현해야 합니다. CLASSPATH를 설정하지 않으면 RestProducerFactory SPI를 구현하는 단일 구성 요소를 검색합니다. 엔드포인트 구성에서 재정의할 수 있습니다.

 

문자열

사용량 (producer)

이 구성 요소를 사용할 수 있는 페이로드 유형은 무엇입니까. RFC7231에 따라 application/json, application/xml, q=0.5처럼 application/json 또는 여러 유형의 유형일 수 있습니다. 이는 Accept HTTP 헤더 값과 동일합니다. 설정된 경우 Swagger 사양에 있는 모든 값이 재정의됩니다. 끝점 구성에서 재정의할 수 있습니다.

 

문자열

호스트 (producer)

https://hostname:port 형식으로 HTTP 요청을 전달하는 스키마 호스트 이름과 포트 Camel Context의 엔드포인트, 구성 요소 또는 복제 복제 REST 구성에서 구성할 수 있습니다. 이 구성 요소에 REST 구성이 첫 번째, rest-swagger 및 마지막 전역 구성이 참조되는 이름(예: petstore)을 지정하는 경우 다음을 수행합니다. 설정된 경우 Swagger 사양에 있는 모든 값 RestConfiguration을 덮어씁니다. 엔드포인트 구성에서 재정의할 수 있습니다.

 

문자열

produces (producer)

이 구성 요소가 생성하는 페이로드 유형은 무엇입니까. 예를 들면 RFC7231에 따른 application/json입니다. 이는 Content-Type HTTP 헤더 값과 동일합니다. 설정된 경우 Swagger 사양에 있는 모든 값이 재정의됩니다. 엔드포인트 구성에서 재정의할 수 있습니다.

 

문자열

specificationUri (producer)

Swagger 사양 파일의 경로입니다. 스키마, 호스트 기본 경로는 이 사양에서 가져오지만 구성 요소 또는 끝점 수준에 대한 속성으로 재정의할 수 있습니다. 구성 요소를 지정하지 않으면 swagger.json 리소스를 로드합니다. 이 구성 요소의 구성 요소 및 엔드포인트에 정의된 호스트에는 스키마, 호스트 이름 및 선택적으로 URI 구문의 포트(예: https://api.example.com:8080)가 포함되어야 합니다. 엔드포인트 구성에서 재정의할 수 있습니다.

swagger.json

URI

resolveProperty Placeholders (advanced)

구성 요소가 시작 시 자체적으로 속성 자리 표시자를 확인해야 하는지 여부입니다. String 유형의 속성만 속성 자리 표시자를 사용할 수 있습니다.Only properties which are of String type can use property placeholders.

true

boolean

REST Swagger 엔드포인트는 URI 구문을 사용하여 구성됩니다.

rest-swagger:specificationUri#operationId

다음 경로 및 쿼리 매개변수를 사용합니다.

278.2.1. 경로 매개 변수(2 매개변수):

이름설명기본값유형

specificationUri

Swagger 사양 파일의 경로입니다. 스키마, 호스트 기본 경로는 이 사양에서 가져오지만 구성 요소 또는 끝점 수준에 대한 속성으로 재정의할 수 있습니다. 구성 요소를 지정하지 않으면 swagger.json 리소스를 로드합니다. 이 구성 요소의 구성 요소 및 엔드포인트에 정의된 호스트에는 스키마, 호스트 이름 및 선택적으로 URI 구문의 포트(예: https://api.example.com:8080)가 포함되어야 합니다. 구성 요소 구성을 재정의합니다.

swagger.json

URI

operationId

Swagger 사양의 작업의 필수 ID입니다.

 

문자열

Red Hat logoGithubRedditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

© 2024 Red Hat, Inc.