335장. 옵션
OpenApi 모듈은 다음 옵션을 사용하여 구성할 수 있습니다. 서블릿을 사용하여 구성하려면 위에 표시된 대로 init-param을 사용합니다. rest-dsl에서 직접 구성할 때 enableCORS,host,contextPath, dsl과 같은 적절한 방법을 사용합니다. api.xxx 가 포함된 옵션은 apiProperty dsl을 사용하여 구성됩니다.
| 옵션 | 유형 | 설명 |
|---|---|---|
| CORS | 부울 | CORS 활성화 여부입니다. 이는 REST 서비스에 대한 실제 액세스 권한이 아닌 api 브라우저의 CORS만 활성화합니다. 기본값은 false입니다. |
| openapi.version | 문자열 | OpenAPI 사양 버전입니다. 기본값은 3.0입니다. |
| host | 문자열 | 호스트 이름을 설정하려면 다음을 수행합니다. camel-openapi-java를 구성하지 않으면 이름을 localhost 기반로 계산합니다. |
| 스키마 | 문자열 | 사용할 프로토콜 체계입니다. 여러 값은 "http,https"와 같은 쉼표로 구분할 수 있습니다. 기본값은 "http"입니다. |
| base.path | 문자열 |
필수: REST 서비스를 사용할 수 있는 기본 경로를 설정합니다. 경로는 상대적인(예: http/https로 시작하지 않음) 및 camel-openapi-java는 런타임 시 절대 기본 경로를 계산합니다. 이 경로는 |
| api.path | 문자열 |
API를 사용할 수 있는 경로 설정(예: /api-docs) 경로는 상대 경로(예: http/https로 시작하지 않음) 및 camel-openapi-java는 런타임 시 절대 기본 경로를 계산합니다. 이 경로는 |
| api.version | 문자열 | API의 버전입니다. 기본값은 0.0.0입니다. |
| api.title | 문자열 | 애플리케이션의 이름입니다. |
| api.description | 문자열 | 애플리케이션에 대한 간단한 설명입니다. |
| api.termsOfService | 문자열 | API의 서비스 약관에 대한 URL입니다. |
| api.contact.name | 문자열 | 연락할 사람 또는 조직의 이름 |
| api.contact.email | 문자열 | API 관련 대응에 사용할 이메일입니다. |
| api.contact.url | 문자열 | 자세한 내용은 웹 사이트의 URL입니다. |
| api.license.name | 문자열 | API에 사용되는 라이센스 이름입니다. |
| api.license.url | 문자열 | API에 사용된 라이센스의 URL입니다. |
| apiContextIdListing | boolean | REST 서비스가 있는 JVM의 모든 CamelContext 이름을 나열할 수 있는지 여부입니다. 활성화되면 api-doc의 루트 경로에 모든 컨텍스트가 나열됩니다. 비활성화하면 컨텍스트 ID가 나열되지 않고 api-doc의 루트 경로에 현재 CamelContext가 나열됩니다. 기본값은 false입니다. |
| apiContextIdPattern | 문자열 | 컨텍스트 목록에 표시된 CamelContext 이름을 필터링할 수 있는 패턴입니다. 패턴은 정규식과 *를 와일드카드로 사용합니다. Intercept에서 사용하는 것과 동일한 패턴 일치 |
