Samples folder

Jérémie Bresson edited this page Jul 30, 2018 · 2 revisions

In this repository we have a samples/ folder that contains example project generated with the generator.

Source script: bin/* Output: samples/

TODO:

  • explain ensure-up-to-date script #80

samples.ci folder

In an ideal world, we consider that contributors always can remove a specific output in the samples/ folder and re-generate it from the corresponding bin/*.sh script.

This is not always the case, as our CI-Jobs sometimes need additional items that are not generated by the generator. For example maven is used to orchestrate the execution of the tests in each samples. As a consequence, a pom.xml file is requested in the generated sample. The generator does not create it, because this is uncommon to use maven to compile and test a sample in an other language (ruby, typescript, ...).

The idea to solve this project is to have an other folder samples.ci/ that contains the manually written items that are copied to the samples/ folder after generation of the example project.

Scripts

Table to find the script corresponding to an output folder in the samples/ folder (this help to (re)generate one of the example):

Sh script Output
bin/security/csharp-petstore.sh samples/client/petstore-security-test/csharp/SwaggerClient
bin/security/go-petstore.sh samples/client/petstore-security-test/go
bin/security/java-petstore-okhttp-gson.sh samples/client/petstore-security-test/java/okhttp-gson
bin/security/javascript-petstore.sh samples/client/petstore-security-test/javascript
bin/security/javascript-closure-angular.sh samples/client/petstore-security-test/javascript-closure-angular
bin/security/objc-petstore.sh samples/client/petstore-security-test/objc
bin/security/perl-petstore.sh samples/client/petstore-security-test/perl
bin/security/php-petstore.sh samples/client/petstore-security-test/php
bin/security/python-petstore.sh samples/client/petstore-security-test/python
bin/security/qt5cpp-petstore.sh samples/client/petstore-security-test/qt5cpp
bin/security/ruby-petstore.sh samples/client/petstore-security-test/ruby
bin/security/scala-petstore.sh samples/client/petstore-security-test/scala
bin/security/swift-petstore.sh samples/client/petstore-security-test/swift
bin/security/typescript-angular.sh samples/client/petstore-security-test/typescript-angular
bin/security/typescript-angular2.sh samples/client/petstore-security-test/typescript-angular2
bin/security/typescript-fetch-petstore.sh samples/client/petstore-security-test/typescript-fetch
bin/security/typescript-inversify.sh samples/client/petstore-security-test/typescript-inversify
bin/security/typescript-jquery-all.sh samples/client/petstore-security-test/typescript-jquery/default
bin/security/typescript-node.sh samples/client/petstore-security-test/typescript-node
bin/ada-petstore.sh samples/client/petstore/ada
bin/akka-scala-petstore.sh samples/client/petstore/akka-scala
bin/android-petstore-httpclient.sh samples/client/petstore/android/httpclient
bin/android-petstore-volley.sh samples/client/petstore/android/volley
bin/apex-petstore.sh samples/client/petstore/apex
bin/bash-petstore.sh samples/client/petstore/bash
bin/clojure-petstore.sh samples/client/petstore/clojure
bin/cpprest-petstore.sh samples/client/petstore/cpprest
bin/csharp-dotnet2-petstore.sh samples/client/petstore/csharp-dotnet2/SwaggerClientTest/Lib/SwaggerClient
bin/csharp-petstore.sh samples/client/petstore/csharp/SwaggerClient
bin/csharp-petstore-net-35.sh samples/client/petstore/csharp/SwaggerClientNet35
bin/csharp-petstore-net-40.sh samples/client/petstore/csharp/SwaggerClientNet40
bin/csharp-petstore-netcore-project.sh samples/client/petstore/csharp/SwaggerClientNetCoreProject
bin/csharp-petstore-net-standard.sh samples/client/petstore/csharp/SwaggerClientNetStandard
bin/csharp-property-changed-petstore.sh samples/client/petstore/csharp/SwaggerClientWithPropertyChanged
bin/dart-flutter-petstore.sh samples/client/petstore/dart/flutter_petstore/swagger
bin/dart-petstore.sh samples/client/petstore/dart/swagger
bin/eiffel-petstore.sh samples/client/petstore/eiffel/
bin/elixir-petstore.sh samples/client/petstore/elixir
bin/elm-petstore.sh samples/client/petstore/elm
bin/erlang-petstore-client.sh samples/client/petstore/erlang-client
bin/flash-petstore.sh samples/client/petstore/flash
bin/go-petstore.sh samples/client/petstore/go/go-petstore
bin/go-petstore-withxml.sh samples/client/petstore/go/go-petstore-withXml
bin/groovy-petstore.sh samples/client/petstore/groovy
bin/haskell-http-client-petstore.sh samples/client/petstore/haskell-http-client
bin/java-petstore-feign.sh samples/client/petstore/java/feign
bin/java-petstore-google-api-client.sh samples/client/petstore/java/google-api-client
bin/java-petstore-jersey1.sh samples/client/petstore/java/jersey1
bin/java-petstore-jersey2.sh samples/client/petstore/java/jersey2
bin/java-petstore-jersey2-java6.sh samples/client/petstore/java/jersey2-java6
bin/java8-petstore-jersey2.sh samples/client/petstore/java/jersey2-java8
bin/java-petstore-okhttp-gson.sh samples/client/petstore/java/okhttp-gson
bin/java-petstore-okhttp-gson-parcelable.sh samples/client/petstore/java/okhttp-gson-parcelableModel
bin/java-petstore-rest-assured.sh samples/client/petstore/java/rest-assured
bin/java-petstore-resteasy.sh samples/client/petstore/java/resteasy
bin/java-petstore-resttemplate.sh samples/client/petstore/java/resttemplate
bin/java-petstore-resttemplate-withxml.sh samples/client/petstore/java/resttemplate-withXml
bin/java-petstore-retrofit.sh samples/client/petstore/java/retrofit
bin/java-petstore-retrofit2.sh samples/client/petstore/java/retrofit2
bin/java-petstore-retrofit2-play24.sh samples/client/petstore/java/retrofit2-play24
bin/java-petstore-retrofit2-play25.sh samples/client/petstore/java/retrofit2-play25
bin/java-petstore-retrofit2rx.sh samples/client/petstore/java/retrofit2rx
bin/java-petstore-retrofit2rx2.sh samples/client/petstore/java/retrofit2rx2
bin/java-petstore-vertx.sh samples/client/petstore/java/vertx
bin/javascript-petstore.sh samples/client/petstore/javascript
bin/javascript-closure-angular.sh samples/client/petstore/javascript-closure-angular
bin/javascript-es6-petstore.sh samples/client/petstore/javascript-es6
bin/javascript-promise-petstore.sh samples/client/petstore/javascript-promise
bin/javascript-promise-es6-petstore.sh samples/client/petstore/javascript-promise-es6
bin/jaxrs-cxf-client-petstore.sh samples/client/petstore/jaxrs-cxf-client
bin/jmeter-petstore.sh samples/client/petstore/jmeter/
bin/kotlin-client-petstore.sh samples/client/petstore/kotlin
bin/kotlin-client-string.sh samples/client/petstore/kotlin-string
bin/kotlin-client-threetenbp.sh samples/client/petstore/kotlin-threetenbp
bin/lua-petstore.sh samples/client/petstore/lua
bin/objc-petstore-coredata.sh samples/client/petstore/objc/core-data
bin/objc-petstore.sh samples/client/petstore/objc/default
bin/perl-petstore.sh samples/client/petstore/perl
bin/perl-deep-module-petstore.sh samples/client/petstore/perl/deep_module_test
bin/php-petstore.sh samples/client/petstore/php
bin/powershell-petstore.sh samples/client/petstore/powershell
bin/python-petstore.sh samples/client/petstore/python
bin/python-asyncio-petstore.sh samples/client/petstore/python-asyncio
bin/python-tornado-petstore.sh samples/client/petstore/python-tornado
bin/qt5-petstore.sh samples/client/petstore/qt5cpp
bin/r-petstore.sh samples/client/petstore/r_test
bin/ruby-petstore.sh samples/client/petstore/ruby
bin/rust-petstore.sh samples/client/petstore/rust
bin/scala-petstore.sh samples/client/petstore/scala
bin/scala-gatling-petstore.sh samples/client/petstore/scala-gatling
bin/scalaz-petstore.sh samples/client/petstore/scalaz
bin/spring-cloud-feign-petstore.sh samples/client/petstore/spring-cloud
bin/spring-stubs.sh samples/client/petstore/spring-stubs
bin/swift-petstore.sh samples/client/petstore/swift/default
bin/swift-petstore-promisekit.sh samples/client/petstore/swift/promisekit
bin/swift-petstore-rxswift.sh samples/client/petstore/swift/rxswift
bin/swift3-petstore.sh samples/client/petstore/swift3/default
bin/swift3-petstore-objcCompatible.sh samples/client/petstore/swift3/objcCompatible
bin/swift3-petstore-promisekit.sh samples/client/petstore/swift3/promisekit
bin/swift3-petstore-rxswift.sh samples/client/petstore/swift3/rxswift
bin/swift3-petstore-unwraprequired.sh samples/client/petstore/swift3/unwraprequired
bin/swift4-petstore.sh samples/client/petstore/swift4/default
bin/swift4-petstore-objcCompatible.sh samples/client/petstore/swift4/objcCompatible
bin/swift4-petstore-promisekit.sh samples/client/petstore/swift4/promisekit
bin/swift4-petstore-rxswift.sh samples/client/petstore/swift4/rxswift
bin/tizen-petstore.sh samples/client/petstore/tizen
bin/typescript-angular-v2-petstore.sh samples/client/petstore/typescript-angular-v2/default
bin/typescript-angular-v2-petstore-with-npm.sh samples/client/petstore/typescript-angular-v2/npm
bin/typescript-angular-v2-petstore-interfaces.sh samples/client/petstore/typescript-angular-v2/with-interfaces
bin/typescript-angular-v4.3-petstore-with-npm.sh samples/client/petstore/typescript-angular-v4.3/npm
bin/typescript-angular-v4-petstore-with-npm.sh samples/client/petstore/typescript-angular-v4/npm
bin/typescript-angularjs-petstore.sh samples/client/petstore/typescript-angularjs
bin/typescript-aurelia-petstore.sh samples/client/petstore/typescript-aurelia/default
bin/typescript-fetch-petstore.sh samples/client/petstore/typescript-fetch/builds/default
bin/typescript-fetch-petstore-target-es6.sh samples/client/petstore/typescript-fetch/builds/es6-target
bin/typescript-fetch-petstore-interfaces.sh samples/client/petstore/typescript-fetch/builds/with-interfaces
bin/typescript-fetch-petstore-with-npm-version.sh samples/client/petstore/typescript-fetch/builds/with-npm-version
bin/typescript-inversify-petstore.sh samples/client/petstore/typescript-inversify
bin/typescript-jquery-petstore.sh samples/client/petstore/typescript-jquery/default
bin/typescript-jquery-petstore-with-npm.sh samples/client/petstore/typescript-jquery/npm
bin/typescript-node-petstore.sh samples/client/petstore/typescript-node/default
bin/typescript-node-petstore-with-npm.sh samples/client/petstore/typescript-node/npm
bin/swift4-test.sh samples/client/test/swift4/default
bin/apache2-petstore-config.sh samples/config/petstore/apache2
bin/cwiki-petstore.sh samples/documentation/cwiki
bin/dynamic-html.sh samples/dynamic-html
bin/html-petstore.sh samples/html
bin/html-markdown.sh samples/html.md
bin/html2-petstore.sh samples/html2
bin/meta-codegen.sh samples/meta-codegen/lib
bin/security/lumen-petstore-server.sh samples/server/petstore-security-test/lumen
bin/security/silex-petstore-server.sh samples/server/petstore-security-test/silex
bin/security/slim-petstore-server.sh samples/server/petstore-security-test/slim
bin/aspnetcore-petstore-server.sh samples/server/petstore/aspnetcore
bin/erlang-petstore-server.sh samples/server/petstore/erlang-server
bin/finch-petstore-server.sh samples/server/petstore/finch
bin/python-flask-petstore.sh samples/server/petstore/flaskConnexion
bin/python-flask-petstore-python2.sh samples/server/petstore/flaskConnexion-python2
bin/go-petstore-server.sh samples/server/petstore/go-api-server
bin/haskell-servant-petstore.sh samples/server/petstore/haskell-servant
bin/java-inflector-petstore-server.sh samples/server/petstore/java-inflector
bin/java-msf4j-petstore-server.sh samples/server/petstore/java-msf4j/
bin/java-pkmst-petstore-server.sh samples/server/petstore/java-pkmst/
bin/java-play-framework-petstore-server.sh samples/server/petstore/java-play-framework
bin/java-play-framework-petstore-server-api-package-override.sh samples/server/petstore/java-play-framework-api-package-override
bin/java-play-framework-petstore-server-async.sh samples/server/petstore/java-play-framework-async
bin/java-play-framework-petstore-server-controller-only.sh samples/server/petstore/java-play-framework-controller-only
bin/java-play-framework-petstore-server-fake-endpoints.sh samples/server/petstore/java-play-framework-fake-endpoints
bin/java-play-framework-petstore-server-no-bean-validation.sh samples/server/petstore/java-play-framework-no-bean-validation
bin/java-play-framework-petstore-server-no-exception-handling.sh samples/server/petstore/java-play-framework-no-exception-handling
bin/java-play-framework-petstore-server-no-interface.sh samples/server/petstore/java-play-framework-no-interface
bin/java-play-framework-petstore-server-no-swagger-ui.sh samples/server/petstore/java-play-framework-no-swagger-ui
bin/java-play-framework-petstore-server-no-wrap-calls.sh samples/server/petstore/java-play-framework-no-wrap-calls
bin/java-vertx-async-petstore-server.sh samples/server/petstore/java-vertx/async
bin/java-vertx-rx-petstore-server.sh samples/server/petstore/java-vertx/rx
bin/jaxrs-cxf-petstore-server.sh samples/server/petstore/jaxrs-cxf
bin/jaxrs-cxf-petstore-server-annotated-base-path.sh samples/server/petstore/jaxrs-cxf-annotated-base-path
bin/jaxrs-cxf-cdi-petstore-server.sh samples/server/petstore/jaxrs-cxf-cdi
bin/jaxrs-cxf-petstore-server-non-spring-application.sh samples/server/petstore/jaxrs-cxf-non-spring-app
bin/jaxrs-petstore-server-datelib-j8.sh samples/server/petstore/jaxrs-datelib-j8/
bin/jaxrs-resteasy-petstore-server.sh samples/server/petstore/jaxrs-resteasy/default
bin/jaxrs-resteasy-eap-petstore-server.sh samples/server/petstore/jaxrs-resteasy/eap
bin/jaxrs-resteasy-eap-java8-petstore-server.sh samples/server/petstore/jaxrs-resteasy/eap-java8
bin/jaxrs-resteasy-eap-joda-petstore-server.sh samples/server/petstore/jaxrs-resteasy/eap-joda
bin/jaxrs-resteasy-joda-petstore-server.sh samples/server/petstore/jaxrs-resteasy/joda
bin/jaxrs-spec-petstore-server.sh samples/server/petstore/jaxrs-spec
bin/jaxrs-spec-petstore-server-interface.sh samples/server/petstore/jaxrs-spec-interface
bin/jaxrs-spec-petstore-server-interface-returning-response.sh samples/server/petstore/jaxrs-spec-interface-response
bin/jaxrs-jersey1-petstore-server.sh samples/server/petstore/jaxrs/jersey1
bin/jaxrs-jersey1-usetags-petstore-server.sh samples/server/petstore/jaxrs/jersey1-useTags
bin/jaxrs-petstore-server.sh samples/server/petstore/jaxrs/jersey2
bin/jaxrs-usetags-petstore-server.sh samples/server/petstore/jaxrs/jersey2-useTags
bin/kotlin-server-petstore.sh samples/server/petstore/kotlin-server/ktor
bin/lumen-petstore-server.sh samples/server/petstore/lumen
bin/nancyfx-petstore-server.sh samples/server/petstore/nancyfx
bin/nancyfx-petstore-server-async.sh samples/server/petstore/nancyfx-async
bin/nodejs-petstore-server.sh samples/server/petstore/nodejs
bin/nodejs-petstore-google-cloud-functions.sh samples/server/petstore/nodejs-google-cloud-functions
bin/php-silex-petstore-server.sh samples/server/petstore/php-silex
bin/pistache-server-petstore.sh samples/server/petstore/pistache-server
bin/rails5-petstore-server.sh samples/server/petstore/rails5
bin/restbed-petstore-server.sh samples/server/petstore/restbed
bin/rust-server-petstore.sh samples/server/petstore/rust-server
bin/scala-lagom-server-petstore.sh samples/server/petstore/scala-lagom-server
bin/scalatra-petstore-server.sh samples/server/petstore/scalatra
bin/sinatra-petstore-server.sh samples/server/petstore/sinatra
bin/slim-petstore-server.sh samples/server/petstore/slim
bin/spring-mvc-petstore-server.sh samples/server/petstore/spring-mvc
bin/spring-mvc-petstore-j8-async-server.sh samples/server/petstore/spring-mvc-j8-async
bin/spring-mvc-petstore-j8-localdatetime.sh samples/server/petstore/spring-mvc-j8-localdatetime
bin/springboot-petstore-server.sh samples/server/petstore/springboot
bin/springboot-petstore-server-beanvalidation.sh samples/server/petstore/springboot-beanvalidation
bin/spring-delegate.sh samples/server/petstore/springboot-delegate
bin/spring-delegate-j8.sh samples/server/petstore/springboot-delegate-j8
bin/springboot-petstore-server-implicitHeaders.sh samples/server/petstore/springboot-implicitHeaders
bin/springboot-petstore-server-useOptional.sh samples/server/petstore/springboot-useoptional
bin/java-undertow-petstore-server.sh samples/server/petstore/undertow
bin/ze-ph-petstore-server.sh samples/server/petstore/ze-ph
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.