From cc5e79cd0d19d76bed1f9a53b0cf40030e739496 Mon Sep 17 00:00:00 2001 From: wing328 Date: Fri, 17 Jun 2016 19:36:24 +0800 Subject: [PATCH] move server stub doc to wiki --- README.md | 150 +----------------------------------------------------- 1 file changed, 1 insertion(+), 149 deletions(-) diff --git a/README.md b/README.md index 8c37f3f39d5..fb1d8501287 100644 --- a/README.md +++ b/README.md @@ -641,155 +641,7 @@ open index.html ### To build a server stub -You can also use the codegen to generate a server for a couple different frameworks. Take a look here: - -### Node.js - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l nodejs-server \ - -o samples/server/petstore/nodejs -``` - -### PHP Slim - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l slim \ - -o samples/server/petstore/slim -``` - -### PHP Silex - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l silex-PHP \ - -o samples/server/petstore/silex -``` - -### Python Flask (Connexion) - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l python-flask \ - -o samples/server/petstore/flaskConnexion -``` - -### Ruby Sinatra - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l sinatra \ - -o samples/server/petstore/sinatra -``` - -### Scala Scalatra -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l scalatra \ - -o samples/server/petstore/scalatra -``` - -### Java JAX-RS (Jersey v1.18) - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l jaxrs \ - -o samples/server/petstore/jaxrs-jersey -``` - -### Java JAX-RS (Apache CXF 2 / 3) - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l jaxrs-cxf \ - -o samples/server/petstore/jaxrs-cxf -``` - -This Codegen only generate a minimalist server stub. You must add the CXF dependency to your classpath (eg: with Maven) -If you are using CXF v2.x, you must provided a custom ```ResourceComparator``` class. This class will help CXF to choose the good resource interface for mapping an incomming request. The default behavior of CXF v2.x is not correct when many resources interface have the same global path. -See: See http://cxf.apache.org/docs/jax-rs-basics.html#JAX-RSBasics-Customselectionbetweenmultipleresources - -You can found this class here: https://github.com/hiveship/CXF2-resource-comparator/blob/master/src/main/java/CXFInterfaceComparator.java -TODO: This class could be directly generated by the Codegen. - -You must register this class into your JAX-RS configuration file: -```xml - - - -``` - -This is no longer necessary if you are using CXF >=v3.x - -### Java JAX-RS (Resteasy) - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l jaxrs-resteasy \ - -o samples/server/petstore/jaxrs-resteasy -``` - -### Java Spring MVC - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l spring-mvc \ - -o samples/server/petstore/spring-mvc -``` - -### Java SpringBoot - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l springboot \ - -o samples/server/petstore/springboot -``` - -You can also set a Json file with basePackage & configPackage properties : -Example : -``` -{ -"basePackage":"io.swagger", -"configPackage":"io.swagger.config" -} -``` -For use it add option ```-c myOptions.json``` to the generation command - -To Use-it : -in the generated folder try ``` mvn package ``` for build jar. -Start your server ``` java -jar target/swagger-springboot-server-1.0.0.jar ``` -SpringBoot listening on default port 8080 - - -### Haskell Servant - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l haskell-servant \ - -o samples/server/petstore/haskell-servant -``` - -### ASP.NET 5 Web API - -``` -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i http://petstore.swagger.io/v2/swagger.json \ - -l aspnet5 \ - -o samples/server/petstore/aspnet5 -``` +Please refer to https://github.com/swagger-api/swagger-codegen/wiki/Server-stub-generator-HOWTO for more information. ### To build the codegen library