loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-05-13 05:00:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
openapi-generator-original/samples/server/petstore/kotlin-server/ktor
History
Jim Schubert 60ceded171
[ci][cli] Moving ensures script to config-based batch generation of samples (#6509) 
* Ensure CLI-level generator settings are available in additional properties

* Initial conversion to yaml configs

Configs prefix with 1- need to be manually evaluated.

* Add "other" configs not in ensure-up-to-date

* Add other/openapi3 files

* Cleanup all generation scripts

* Clean up: add missed configs and fix some openapi 3 diffs

* Move generate-samples script, error on batch failures

* Temporarily disable elm which requires skip validation of spec

* CI updates (todo: run all generators through appveyor or move to github workflows)

* Add success count to batch generation command output

* [samples] Regenerate

* Remove bin/windows

* Generate swift5 samples in bitrise

* Expand user input glob pattern

* Regenerate samples

* Update PR template

* Support config based generateAliasAsModel

* [samples] Regenerate

* [rust] Generate as alias for all samples configs

* [csharp] Move test staged file changes to in-directory

* Include "live" test files and ignore test cache files from samples.ci

* Remove concept of samples.ci staging

Generators support .openapi-generator-ignore, allowing maintainers to
explicitly ignore the regeneration of files which have been modified.

Note that the tooling does not overwrite test files whenever those files
exist, and it's not entirely necessary to add test files to the ignore
file.

* Re-add meta generator scripts

* Modify ensure-up-to-date to log stdout, so script does not look like it hangs on slower machines

* [csharp] Regenerate sample

* Set generateAliasAsModel CodegenConfigurator#toContext

This ensures the property (which is effectively a thread-local) gets set
as expected if the caller resets GlobalSettings as is done in the
GenerateBatch command.

* [rust] Regenerate samples

* Re-enable elm

* [java] Support OffsetDateTime example, fail ensures script on any generation error

* [samples] Regenerate

* Fix jersey2-java8 ignore file

* Fix elm spec validation

* Force UTC in sample generation to avoid timezone conflicts during generation (user vs ci)

Co-authored-by: William Cheng <wing328hk@gmail.com>
2020-06-09 18:28:58 +08:00
..
.openapi-generator
[core][general] Add metadata file tracking to aid in "Golden Tests" regeneration (#6325)
2020-05-22 16:48:32 -04:00
src/main
[kotlin]Fix ktor doesn't generate nullable types (#5258)
2020-03-01 17:58:58 +08:00
.openapi-generator-ignore
[ci][cli] Moving ensures script to config-based batch generation of samples (#6509)
2020-06-09 18:28:58 +08:00
build.gradle
[gradle] consistent use of maven url in gradle files (#5045)
2020-01-19 14:57:38 -05:00
Dockerfile
[kotlin-server] --library=ktor (barebones implementation) (#7412)
2018-01-27 17:43:46 +08:00
gradle.properties
[kotlin-server] --library=ktor (barebones implementation) (#7412)
2018-01-27 17:43:46 +08:00
pom.xml
Change default package name value for kotlin server (#387)
2018-05-09 16:38:16 +08:00
README.md
update samples
2020-04-21 02:22:55 +08:00
settings.gradle
[kotlin-server] --library=ktor (barebones implementation) (#7412)
2018-01-27 17:43:46 +08:00

README.md

org.openapitools.server - Kotlin Server library for OpenAPI Petstore

This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.

Generated by OpenAPI Generator 5.0.0-SNAPSHOT.

Requires

  • Kotlin 1.3.21
  • Gradle 4.9

Build

First, create the gradle wrapper script:

gradle wrapper

Then, run:

./gradlew check assemble

This runs all tests and packages the library.

Running

The server builds as a fat jar with a main entrypoint. To start the service, run java -jar ./build/libs/kotlin-server.jar.

You may also run in docker:

docker build -t kotlin-server .
docker run -p 8080:8080 kotlin-server

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs (see ktor documentation for more info).
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class Method HTTP request Description
PetApi addPet POST /pet Add a new pet to the store
PetApi deletePet DELETE /pet/{petId} Deletes a pet
PetApi findPetsByStatus GET /pet/findByStatus Finds Pets by status
PetApi findPetsByTags GET /pet/findByTags Finds Pets by tags
PetApi getPetById GET /pet/{petId} Find pet by ID
PetApi updatePet PUT /pet Update an existing pet
PetApi updatePetWithForm POST /pet/{petId} Updates a pet in the store with form data
PetApi uploadFile POST /pet/{petId}/uploadImage uploads an image
StoreApi deleteOrder DELETE /store/order/{orderId} Delete purchase order by ID
StoreApi getInventory GET /store/inventory Returns pet inventories by status
StoreApi getOrderById GET /store/order/{orderId} Find purchase order by ID
StoreApi placeOrder POST /store/order Place an order for a pet
UserApi createUser POST /user Create user
UserApi createUsersWithArrayInput POST /user/createWithArray Creates list of users with given input array
UserApi createUsersWithListInput POST /user/createWithList Creates list of users with given input array
UserApi deleteUser DELETE /user/{username} Delete user
UserApi getUserByName GET /user/{username} Get user by user name
UserApi loginUser GET /user/login Logs user into the system
UserApi logoutUser GET /user/logout Logs out current logged in user session
UserApi updateUser PUT /user/{username} Updated user

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: api_key
  • Location: HTTP header

petstore_auth