Here's a step by step process:
Get swagger-jaxrs: https://mvnrepository.com/artifact/io.swagger/swagger-jaxrs/1.5.0
Create a SwaggerModule.java
in "modules" directory (example: com.mysite.mypkg.modules
)
public class SwaggerModule {
@Contribute(SymbolProvider.class)
@ApplicationDefaults
public static void provideSymbols(MappedConfiguration<String, Object> configuration) {
configuration.add(ResteasySymbols.CORS_ENABLED, true);
}
@Contribute(javax.ws.rs.core.Application.class)
public static void contributeApplication(Configuration<Object> singletons) {
singletons.addInstance(io.swagger.jaxrs.listing.ApiListingResource.class);
singletons.addInstance(io.swagger.jaxrs.listing.SwaggerSerializers.class);
}
@Startup
public static void swagger(javax.ws.rs.core.Application application,
BaseURLSource baseURLSource,
@Symbol(InternalConstants.TAPESTRY_APP_PACKAGE_PARAM) String basePackage,
@Symbol(ResteasySymbols.MAPPING_PREFIX) String restPath,
@Symbol(SymbolConstants.APPLICATION_VERSION) String version) {
application.getSingletons();
BeanConfig config = new BeanConfig();
config.setSchemes(new String[]{"http"});
config.setVersion("1.0.2");
config.setHost("localhost:8080");
config.setBasePath("/mysite" + restPath);
config.setTitle("Mysite Rest Documentation");
config.setResourcePackage("com.mysite.mypkg.rest");//where your rest resources are located
config.setScan(true);
}
On your AppModule.java, import the SwaggerModule (Tapestry 5.4)
@ImportModule(SwaggerModule.class)
public class AppModule {...
}
The swagger.json
and swagger.yaml
can now be accessed as:
http://localhost:8080/mysite/rest/swagger.json
Many thanks to @ascandroli above for pointing out the basics