1 unstable release
0.0.1 | Sep 15, 2021 |
---|
#148 in #server-client
130KB
2.5K
SLoC
Rust API for hvcg_enrolable_openapi_program
This is a sample server program 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 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
- Build date: 2021-09-15T02:42:40.247793086Z[Etc/UTC]
This autogenerated project defines an API crate hvcg_enrolable_openapi_program
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 hvcg_enrolable_openapi_program
:
- The example server starts up a web server using the
hvcg_enrolable_openapi_program
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
hvcg_enrolable_openapi_program
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 DeleteProgram
cargo run --example client GetProgramById
cargo run --example client GetPrograms
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 https://dev-sg.portal.hocvienconggiao.com
Method | HTTP request | Description |
---|---|---|
addProgram | POST /mutation-api/enrolable-service/programs | Add new program |
deleteProgram | DELETE /mutation-api/enrolable-service/programs/{id} | Deletes a program |
updateProgram | PUT /mutation-api/enrolable-service/programs/{id} | Update an existing program |
getProgramById | GET /query-api/enrolable-service/programs/{id} | Find program by ID |
getPrograms | GET /query-api/enrolable-service/programs | Get all programs |
Documentation For Models
Documentation For Authorization
program_auth
- Type: Bearer token authentication
Example
Author
Dependencies
~12–24MB
~351K SLoC