* fix(rust-server): clippy::blacklisted_name -> clippy::disallowed_names * fix(rust-server): Remove unnecessary deref * fix(rust-server): Allow clippy::single_match * fix(rust-server): Use clone instead of to_owned on Cow * fix(rust-server): Remove needless borrows * chore(rust-server): Update sample outputs
Rust API for ops-v3
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
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:
- API version: 0.0.1
This autogenerated project defines an API crate ops-v3
which contains:
- An
Api
trait defining the API in Rust. - Data types representing the underlying data model.
- A
Client
type which implementsApi
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 ops-v3
:
- The example server starts up a web server using the
ops-v3
router, and supplies a trivial implementation ofApi
which returns failure for every operation. - The example client provides a CLI which lets you invoke
any single operation on the
ops-v3
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.
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 Op10Get
cargo run --example client Op11Get
cargo run --example client Op12Get
cargo run --example client Op13Get
cargo run --example client Op14Get
cargo run --example client Op15Get
cargo run --example client Op16Get
cargo run --example client Op17Get
cargo run --example client Op18Get
cargo run --example client Op19Get
cargo run --example client Op1Get
cargo run --example client Op20Get
cargo run --example client Op21Get
cargo run --example client Op22Get
cargo run --example client Op23Get
cargo run --example client Op24Get
cargo run --example client Op25Get
cargo run --example client Op26Get
cargo run --example client Op27Get
cargo run --example client Op28Get
cargo run --example client Op29Get
cargo run --example client Op2Get
cargo run --example client Op30Get
cargo run --example client Op31Get
cargo run --example client Op32Get
cargo run --example client Op33Get
cargo run --example client Op34Get
cargo run --example client Op35Get
cargo run --example client Op36Get
cargo run --example client Op37Get
cargo run --example client Op3Get
cargo run --example client Op4Get
cargo run --example client Op5Get
cargo run --example client Op6Get
cargo run --example client Op7Get
cargo run --example client Op8Get
cargo run --example client Op9Get
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 |
---|---|---|
**** | GET /op10 | |
**** | GET /op11 | |
**** | GET /op12 | |
**** | GET /op13 | |
**** | GET /op14 | |
**** | GET /op15 | |
**** | GET /op16 | |
**** | GET /op17 | |
**** | GET /op18 | |
**** | GET /op19 | |
**** | GET /op1 | |
**** | GET /op20 | |
**** | GET /op21 | |
**** | GET /op22 | |
**** | GET /op23 | |
**** | GET /op24 | |
**** | GET /op25 | |
**** | GET /op26 | |
**** | GET /op27 | |
**** | GET /op28 | |
**** | GET /op29 | |
**** | GET /op2 | |
**** | GET /op30 | |
**** | GET /op31 | |
**** | GET /op32 | |
**** | GET /op33 | |
**** | GET /op34 | |
**** | GET /op35 | |
**** | GET /op36 | |
**** | GET /op37 | |
**** | GET /op3 | |
**** | GET /op4 | |
**** | GET /op5 | |
**** | GET /op6 | |
**** | GET /op7 | |
**** | GET /op8 | |
**** | GET /op9 |
Documentation For Models
Documentation For Authorization
Endpoints do not require authorization.