# Rust API for rust-server-test

This spec is for testing rust-server-specific things

## Overview

This client/server was generated by the [openapi-generator]
(https://openapi-generator.tech) project.  By using the
[OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote
server, you can easily generate a server stub.

To see how to make this your own, look here:

[README]((https://openapi-generator.tech))

- API version: 2.3.4




This autogenerated project defines an API crate `rust-server-test` which contains:
* An `Api` trait defining the API in Rust.
* Data types representing the underlying data model.
* A `Client` type which implements `Api` and issues HTTP requests for each operation.
* A router which accepts HTTP requests and invokes the appropriate `Api` method for each operation.

It also contains an example server and client which make use of `rust-server-test`:

* The example server starts up a web server using the `rust-server-test`
    router, and supplies a trivial implementation of `Api` which returns failure
    for every operation.
* The example client provides a CLI which lets you invoke
    any single operation on the `rust-server-test` client by passing appropriate
    arguments on the command line.

You can use the example server and client as a basis for your own code.
See below for [more detail on implementing a server](#writing-a-server).

## Examples

Run examples with:

```
cargo run --example <example-name>
```

To pass in arguments to the examples, put them after `--`, for example:

```
cargo run --example client -- --help
```

### Running the example server
To run the server, follow these simple steps:

```
cargo run --example server
```

### Running the example client
To run a client, follow one of the following simple steps:

```
cargo run --example client AllOfGet
cargo run --example client DummyGet
cargo run --example client FileResponseGet
cargo run --example client GetStructuredYaml
cargo run --example client HtmlPost
cargo run --example client PostYaml
cargo run --example client RawJsonGet
```

### HTTPS
The examples can be run in HTTPS mode by passing in the flag `--https`, for example:

```
cargo run --example server -- --https
```

This will use the keys/certificates from the examples directory. Note that the
server chain is signed with `CN=localhost`.

## Using the generated library

The generated library has a few optional features that can be activated through Cargo.

* `server`
    * This defaults to enabled and creates the basic skeleton of a server implementation based on hyper
    * To create the server stack you'll need to provide an implementation of the API trait to provide the server function.
* `client`
    * This defaults to enabled and creates the basic skeleton of a client implementation based on hyper
    * The constructed client implements the API trait by making remote API call.
* `conversions`
    * This defaults to disabled and creates extra derives on models to allow "transmogrification" between objects of structurally similar types.

See https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section for how to use features in your `Cargo.toml`.

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**AllOf_Get**](docs/default_api.md#AllOf_Get) | **GET** /allOf | 
[**dummyGet**](docs/default_api.md#dummyGet) | **GET** /dummy | A dummy endpoint to make the spec valid.
[**dummyPut**](docs/default_api.md#dummyPut) | **PUT** /dummy | 
[**file_responseGet**](docs/default_api.md#file_responseGet) | **GET** /file_response | Get a file
[**getStructuredYaml**](docs/default_api.md#getStructuredYaml) | **GET** /get-structured-yaml | 
[**htmlPost**](docs/default_api.md#htmlPost) | **POST** /html | Test HTML handling
[**post_yaml**](docs/default_api.md#post_yaml) | **POST** /post-yaml | 
[**raw_jsonGet**](docs/default_api.md#raw_jsonGet) | **GET** /raw_json | Get an arbitrary JSON blob.
[**solo_objectPost**](docs/default_api.md#solo_objectPost) | **POST** /solo-object | Send an arbitrary JSON blob


## Documentation For Models

 - [ANullableContainer](docs/ANullableContainer.md)
 - [AdditionalPropertiesObject](docs/AdditionalPropertiesObject.md)
 - [AllOfObject](docs/AllOfObject.md)
 - [BaseAllOf](docs/BaseAllOf.md)
 - [DummyPutRequest](docs/DummyPutRequest.md)
 - [GetYamlResponse](docs/GetYamlResponse.md)
 - [ObjectOfObjects](docs/ObjectOfObjects.md)
 - [ObjectOfObjectsInner](docs/ObjectOfObjectsInner.md)


## Documentation For Authorization
 Endpoints do not require authorization.


## Author