loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

added notes about generating your own files

Browse Source
This commit is contained in:
Tony Tam 2012-08-24 22:41:35 -07:00
parent a50f0627f9
commit b92a84eed8
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,10 +1,9 @@
# Swagger Client Code-Generator # Swagger Client Code-Generator
## Overview ## Overview
This is a project to build the Swagger code-gen library which can be used to automatically This is the swagger codegen project, which allows generation of client libraries automatically from a
generate client libraries from a Swagger-compliant server. You can find out more about both Swagger-compliant server. You can find out more about both the spec and the framework at
the spec and the framework at http://swagger.wordnik.com. For more information about Wordnik's http://swagger.wordnik.com. For more information about Wordnik's APIs, please visit http://developer.wordnik.com.
APIs, please visit http://developer.wordnik.com.
### Prerequisites ### Prerequisites
You need the following installed and available in your $PATH: You need the following installed and available in your $PATH:
@ -61,6 +60,9 @@ import com.wordnik.swagger.core._
object MyCodegen extends BasicScalaGenerator { object MyCodegen extends BasicScalaGenerator {
def main(args: Array[String]) = generateClient(args) def main(args: Array[String]) = generateClient(args)
// location of templates
override def templateDir = "scala"
// where to write generated code // where to write generated code
override def destinationDir = "client/scala/src/main/scala" override def destinationDir = "client/scala/src/main/scala"
@ -89,6 +91,14 @@ Now you can generate your client like this:
w00t! Thanks to the scala interpretor, you didn't even need to recompile. w00t! Thanks to the scala interpretor, you didn't even need to recompile.
### Modifying the client library format
Don't like the default swagger client syntax? Want a different language supported? No problem! Swagger codegen
processes mustache templates with the [scalate](http://scalate.fusesource.org/) engine. You can modify our templates or
make your own.
You can look at src/main/resources/${your-language} for examples. To make your own templates, create your own files
and override the `templateDir` in your script to point to the right place. It actually is that easy.
### Where is Javascript??? ### Where is Javascript???
See our [javascript library](http://github.com/wordnik/swagger.js)--it's completely dynamic and doesn't require See our [javascript library](http://github.com/wordnik/swagger.js)--it's completely dynamic and doesn't require
static code generation. static code generation.