forked from loafle/openapi-generator-original
* Revert "v7.12.0 release" This reverts commit 073723cb4d41187f839fbb46565d109293fa22d7. * set version to v7.13.0-SNAPSHOT * update samples * update doc
61 lines
1.5 KiB
Markdown
61 lines
1.5 KiB
Markdown
# org.openapitools.server - Kotlin Server library for Nullable Required
|
|
|
|
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
|
|
Generated by OpenAPI Generator 7.13.0-SNAPSHOT.
|
|
|
|
## 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.
|
|
|
|
<a id="documentation-for-api-endpoints"></a>
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to */api/v3*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*DefaultApi* | [**addPet**](docs/DefaultApi.md#addpet) | **POST** /pet |
|
|
|
|
|
|
<a id="documentation-for-models"></a>
|
|
## Documentation for Models
|
|
|
|
- [org.openapitools.server.models.Pet](docs/Pet.md)
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## Documentation for Authorization
|
|
|
|
Endpoints do not require authorization.
|
|
|