THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| Name | Description | Default |
|---|---|---|
| basePath | the context root path+ | null |
| contact | the contact information+ | null (in CXF 3.1.x "users@cxf.apache.org") |
| description | the description+ | null (in CXF 3.1.x "The Application") |
| filterClass | a security filter+ | null |
| host | the host and port+ | null |
| ignoreRoutes | excludes specific paths when scanning all resources (see scanAllResources)++ | null |
| license | the license+ | "Apache 2.0 License" |
| licenceUrl | the license URL+ | "http://www.apache.org/licenses/LICENSE-2.0.html" |
| prettyPrint | when generating swagger.json, pretty-print the json document+ | false |
| resourcePackage | a list of comma separated package names where resources must be scanned+ | a list of service classes configured at the endpoint |
| runAsFilter | runs the feature as a filter | false |
| scan | generates the swagger documentation+ | true |
| scanAllResources | scans all resources including non-annotated JAX-RS resources++ | false |
| schemes | the protocol schemes+ | null |
| termsOfServiceUrl | the terms of service URL+ | null |
| title | the title+ | null (in CXF 3.1.x "Sample REST Application") |
| version | the version+ | null (in CXF 3.1.x "1.0.0") |
Note: those descriptions marked with + correspond to the properties defined in Swagger's BeanConfig, and those marked with ++ correspond to the properties defined in Swagger's ReaderConfig.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
import org.apache.cxf.frontend.ServerFactoryBean; import org.apache.cxf.jaxrs.swagger.Swagger2Feature; ... Swagger2Feature feature = new Swagger2Feature(); // customize some of the properties feature.setBasePath("/api"); // add this feature to the endpoint (e.g., to ServerFactoryBean's features) ServerFactoryBean sfb = new ServerFactoryBean(); sfb.getFeatures().add(feature); |
...