generate static swagger documentation or client stubs with codgen and gradle (with JavaExec)

Swagger ist a possible language independent solution to describe your REST based services. I use it currently together with spring-boot to provide my mobile json api.

To generate docs and client stubs with gradle I resort to:
task genSwagger(type: JavaExec) {
    description "generate swagger doc or clients via codgen package and gradle"
    // needing buildscript dependency  classpath "com.wordnik:swagger-codegen:2.1.2-M1"
    classpath = buildscript.configurations.classpath
    args  = ["-i", "http://localhost:8080/........-rest-api", "-o", "${buildDir}/docs/rest-api", "-l", "android"]
    main      = "com.wordnik.swagger.codegen.Codegen"
}
run with "gradlew genSwagger"

As of today to my knowledge no stable gradle plugin exists for codegen (maven only), so starting it's Main class from gradle is my solution for now.

see also:
http://swagger.io/
https://github.com/springdox/springdox
https://github.com/swagger-api/swagger-codegen
http://gradle.org

Kommentare

Kommentar veröffentlichen

Beliebte Posts aus diesem Blog

using the birt runtime with spring boot and gradle to generate PDF from a Report Design File

Warning: at the moment not recommended as solution. Personal Note (too complicated to keep in my brain / transient memory) birt simply does not think in this way: push data into report vs pull datasource, osgi vs. maven, design time jars.... Step 1: use with gradle: get dependencies from maven repo: compile ( group : 'org.eclipse.birt.runtime' , name : 'org.eclipse.birt.runtime' , version : '4.4.1' ) {    exclude module : 'flute'    exclude module : 'org.eclipse.orbit.mongodb' } // also working 4.2.1a  // not compiling:     4.6.0-20160607 // not running:  4.5.0a Step 2: create POJO and a suitable BIRT DataSource for the Designer: http://yaragalla.blogspot.de/2013/10/using-pojo-datasource-in-birt-43.html DataSource really needs the open, next and close Methods build as jar, needed as such in BIRT Designer Step 3: use BIRT runtime in your Spring Boot Controller: InputStream reportDesign = getClass(). ...
Mehr anzeigen

Debugging angular 4 Jasmin/Karma tests with Visual Studio Code

Bild
remember how to debug with visual studio code an angular cli generated jasmin test. Change the config: add to visual studio code launch.config ... { "type" : "chrome" , "request" : "attach" , "name" : "Attach to karma test runner" , "sourceMaps" : true , "port" : 9333 , "webRoot" : "${workspaceRoot}" , "sourceMapPathOverrides" : { "webpack:///*" : "${workspaceRoot}/*" } }, add to karma conf.js ... singleRun: false , browsers: [ 'ChromeDebugging' ], customLaunchers: { ChromeDebugging: { base: 'Chrome' , flags: [ '--remote-debugging-port=9333' ] } }, Start the debugging session: ng test set some breakpoints in visual studio code start " Attach to Karma Tests " in Visual Studio Code refre...
Mehr anzeigen