forked from loafle/openapi-generator-original
c7e9bd2f29
* Skip post processing when generating JAXRS spec with Kotlin This feature was previously added to work with the javalin5 library * Add sample that proves what we expect after fixing this * Update sample * Added new samples to samples workflow * Revert from jdk17 pipeline
57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
# org.openapitools.server - Kotlin Server library for OpenAPI Stuff API created to reproduce issue
|
|
|
|
## Requires
|
|
|
|
* Kotlin 1.4.31
|
|
* Gradle 6.8.2
|
|
|
|
## Build
|
|
|
|
First, create the gradle wrapper script:
|
|
|
|
```
|
|
gradle wrapper
|
|
```
|
|
|
|
Then, run:
|
|
|
|
```
|
|
./gradlew check assemble
|
|
```
|
|
|
|
This runs all tests and packages the library.
|
|
|
|
## Features/Implementation Notes
|
|
|
|
* Supports JSON inputs/outputs, File inputs, and Form inputs.
|
|
* 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 *https://example.org/v1*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*StuffApi* | [**findStuff**](docs/StuffApi.md#findstuff) | **GET** /stuff | Finds stuff
|
|
*StuffApi* | [**findUniqueStuff**](docs/StuffApi.md#finduniquestuff) | **GET** /uniquestuff | Finds unique stuff
|
|
|
|
|
|
<a id="documentation-for-models"></a>
|
|
## Documentation for Models
|
|
|
|
- [org.openapitools.server.models.Stuff](docs/Stuff.md)
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## Documentation for Authorization
|
|
|
|
|
|
Authentication schemes defined for the API:
|
|
<a id="bearerAuth"></a>
|
|
### bearerAuth
|
|
|
|
- **Type**: HTTP Bearer Token authentication (JWT)
|
|
|