openapi-generator/samples/server/petstore/rust-server/output/rust-server-test

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 from a remote server, you can easily generate a server stub.

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

README

• API version: 2.3.4
• Generator version: 7.20.0-SNAPSHOT

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.
• A CLI tool to drive basic API operations from the command line.

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 the examples.

CLI

Run the included CLI tool with:

cargo run --bin cli --features=cli

To pass in arguments, put them after --, for example:

cargo run --bin cli --features=cli -- --help

See the help text for available options.

To build a standalone tool, use:

cargo build --bin cli --features=cli --release

You'll find the binary at target/release/cli.

Examples

Run examples with:

cargo run --example rust-server-test-<client|server>

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

cargo run --example rust-server-test-client -- --help

Running the example server

To run the server, follow these simple steps:

cargo run --example rust-server-test-server

Running the example client

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

cargo run --example rust-server-test-client AllOfGet
cargo run --example rust-server-test-client DummyGet
cargo run --example rust-server-test-client FileResponseGet
cargo run --example rust-server-test-client GetStructuredYaml
cargo run --example rust-server-test-client HtmlPost
cargo run --example rust-server-test-client PostYaml
cargo run --example rust-server-test-client RawJsonGet

HTTPS

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

cargo run --example rust-server-test-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.
• client-tls
  • This default to enabled and provides HTTPS support with automatic TLS backend selection:
    • macOS/Windows/iOS: native-tls + hyper-tls
    • Linux/Unix/others: OpenSSL + hyper-openssl
• conversions
  • This defaults to disabled and creates extra derives on models to allow "transmogrification" between objects of structurally similar types.
• cli
  • This defaults to disabled and is required for building the included CLI tool.
• validate
  • This defaults to disabled and allows JSON Schema validation of received data using MakeService::set_validation or Service::set_validation.
  • Note, enabling validation will have a performance penalty, especially if the API heavily uses regex based checks.

HTTPS/TLS Support

HTTPS support is included by default. To disable it (for example, to reduce dependencies), you can:

[dependencies]
rust-server-test = { version = "2.3.4", default-features = false, features = ["client", "server"] }

For server with callbacks that need HTTPS:

[dependencies]
rust-server-test = { version = "2.3.4", features = ["server", "client-tls"] }

The TLS backend is automatically selected based on your target platform:

• macOS, Windows, iOS: Uses native-tls (system TLS libraries)
• Linux, Unix, other platforms: Uses openssl

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	GET /allOf
dummyGet	GET /dummy	A dummy endpoint to make the spec valid.
dummyPut	PUT /dummy
file_responseGet	GET /file_response	Get a file
getStructuredYaml	GET /get-structured-yaml
htmlPost	POST /html	Test HTML handling
post_yaml	POST /post-yaml
raw_jsonGet	GET /raw_json	Get an arbitrary JSON blob.
solo_objectPost	POST /solo-object	Send an arbitrary JSON blob

Documentation For Models

• ANullableContainer
• AdditionalPropertiesObject
• AllOfObject
• BaseAllOf
• DummyPutRequest
• GetYamlResponse
• ObjectOfObjects
• ObjectOfObjectsInner
• UnnamedAllofUnderProperties
• UnnamedReference

Documentation For Authorization

Endpoints do not require authorization.

Author