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

Merge branch 'master' of github.com:wordnik/swagger-codegen

Browse Source
This commit is contained in:
Russell Horton 2012-09-10 00:28:08 -07:00
commit 4d15674803
3 changed files with 67 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
samples/server-generator/scalatra/README.md
View File

@ -47,7 +47,7 @@ $ find -type f
```
To run the server, cd to the `samples/server-generator/node/output` folder and run:
To run the server, cd to the `samples/server-generator/scalatra/output` folder and run:
```
sbt run
@ -67,7 +67,7 @@ Take a look at the sample templates here:
<li> - Generator for your models: [model.mustache](https://github.com/wordnik/swagger-codegen/blob/master/samples/server-generator/scalatra/templates/model.mustache)
<li> - The main class to run your server: [ServletApp.mustache](https://github.com/wordnik/swagger-codegen/blob/master/samples/server-generator/node/templates/ServletApp.mustache)
<li> - The main class to run your server: [ServletApp.mustache](https://github.com/wordnik/swagger-codegen/blob/master/samples/server-generator/scalatra/templates/ServletApp.mustache)
Sound easy? It is!

64
samples/server-generator/sinatra/README.md Normal file
View File

@ -0,0 +1,64 @@
# Swagger generated server
## Overview
Using the swagger-codegen, you can not only generate clients but servers as well! The same spec can be used to drive your
development both ways. This is an example of generating a server for `node.js`.
### Prerequisites
You need the following installed and available in your $PATH:
<li>- Scala 2.9.1 [available here](http://www.scala-lang.org)
You also need to add scala binary to your PATH.
### Generating a server
You first need to build the `swagger-codegen` project--this is done by running this command at the root of the swagger-codegen project:
```
mvn package
```
You can now generate a server from any valid[**](https://github.com/wordnik/swagger-codegen/blob/master/README.md#validating-your-swagger-spec) swagger spec:
```
./bin/runscala.sh samples/server-generator/sinatra/SinatraServerGenerator.scala http://petstore.swagger.wordnik.com/api/resources.json special-key
```
After executing this script, you will have an output directory with the server-generated files:
```
$ cd samples/server-generator/sinatra/output
$ find . -type f
./config.ru
./Gemfile
./Gemfile.lock
./lib/pet_api.rb
./lib/store_api.rb
./lib/swaggering.rb
./lib/user_api.rb
./my_app.rb
./README.md
```
To run the server, cd to the `samples/server-generator/sinatra/output` folder and run:
```
rackup -p 4567
```
You can now load the swagger-ui against `http://localhost:4567/resources.json`. Of course this isn't a fully
runnable server! You have to add the logic in the lib/*.rb files. But that's the easy part.
### Making it your own
Running the sample is easy, but how about making your own server? Easy! Just modify the `samples/server-generator/sinatra/SinatraServerGenerator.scala` file.
Don't like the templates? Don't worry, we're not offended! They're [mustache](http://mustache.github.com/) templates and are easy to modify.
Take a look at the sample templates here:
<li> - Generator for your api classes: [api.mustache](https://github.com/wordnik/swagger-codegen/blob/master/samples/server-generator/sinatra/templates/api.mustache)
<li> - The main class to run your server: [my_app.mustache](https://github.com/wordnik/swagger-codegen/blob/master/samples/server-generator/sinatra/templates/my_app.mustache)
Sound easy? It is!

2
samples/server-generator/sinatra/output/README.md
View File

@ -17,7 +17,7 @@ sinatra-cross_origin
This sample was generated with the [swagger-codegen](https://github.com/wordnik/swagger-codegen) project.
```
rackup -p 4567 examples/config.ru
rackup -p 4567
```
In your [swagger ui](https://github.com/wordnik/swagger-ui), put in the following URL: