# Rust API for hvcg_biography_openapi_saint
This is a sample server Saint info server. For this sample, you can use the api key `special-key` to test the authorization filters.
## 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: 0.3.3
- Build date: 2021-06-30T04:47:40.394471755Z[Etc/UTC]
This autogenerated project defines an API crate `hvcg_biography_openapi_saint` 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 `hvcg_biography_openapi_saint`:
* The example server starts up a web server using the `hvcg_biography_openapi_saint`
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 `hvcg_biography_openapi_saint` 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 DeleteSaint
cargo run --example client GetAllSaints
cargo run --example client GetSaintById
```
### 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://dev-sg.portal.hocvienconggiao.com*
[**addSaint**](docs/saint_api.md#addSaint) | **POST** /mutation-api/saints | Add new saint
[**delete_saint**](docs/saint_api.md#delete_saint) | **DELETE** /mutation-api/saint | Deletes a saint
[**getAllSaints**](docs/saint_api.md#getAllSaints) | **GET** /query-api/saints | Get all saints
[**get_saint_by_id**](docs/saint_api.md#get_saint_by_id) | **GET** /query-api/saints/{id} | Find saint by ID
[**update_saint**](docs/saint_api.md#update_saint) | **PUT** /mutation-api/saint | Update an existing saint
## Documentation For Models
- [Gender](docs/Gender.md)
- [Saint](docs/Saint.md)
## Documentation For Authorization
## saint_auth
- **Type**: Bearer token authentication
Example
```
```
## Author