d03c90cb97
With:
```
sampleObject:
type: object
additionalProperties:
$ref: '#/components/schemas/SampleData'
minProperties: 1
description: Map of Charging data policy decisions.
```
and
```
SampleData:
type: object
...
nullable: true
```
We currently generate: HashMap<String, SampleData>, which doesn't allow
null charging data entries. This MR changes this to be
`HashMap<String, swagger::Nullable<SampleData>>`, which thus will allow null data entries.
We do this by moving null-handling to the Java code - primarily `getTypeDeclaration()`.
Note, to some extent this is wrong. In this MR (and previously) we are treating
`nullable: true` as an extrinsic property (like required), whereas it should be an
intrinsic property (and thus `HashMap<String, SampleData>` is correct, but `SampleData`
absorbs the nullability.
This would be possible with this code:
```
enum ChargingData = {
Null,
Present {
...
}
}
```
Which would remove the usage of https://docs.rs/swagger/2.0.2/swagger/nullable_format/enum.Nullable.html.
I haven't resolved this - and have instead done a more targeted fix.
This, along with some other crude code, creates a scenario where we need to
unpick whether something is null. I've left that, though flagged a TODO to tidy it up at some point.
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:
- API version: 2.3.4
- Generator version: 7.9.0-SNAPSHOT
This autogenerated project defines an API crate rust-server-test which contains:
- An
Apitrait defining the API in Rust. - Data types representing the underlying data model.
- A
Clienttype which implementsApiand issues HTTP requests for each operation. - A router which accepts HTTP requests and invokes the appropriate
Apimethod 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-testrouter, and supplies a trivial implementation ofApiwhich returns failure for every operation. - The example client provides a CLI which lets you invoke
any single operation on the
rust-server-testclient 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 <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.
cli- This defaults to disabled and is required for building the included CLI tool.
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
Documentation For Authorization
Endpoints do not require authorization.