14 releases

0.1.6 Aug 29, 2021
0.1.5 Aug 28, 2021
0.0.9 Aug 11, 2021
0.0.3 Jul 14, 2021

#28 in #api-server

Unlicense

175KB
3K SLoC

Rust API for hvcg_iam_openapi_identity

This is a API for identity.

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: 0.1.6
  • Build date: 2021-08-29T04:13:56.401156901Z[Etc/UTC]

This autogenerated project defines an API crate hvcg_iam_openapi_identity 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_iam_openapi_identity:

  • The example server starts up a web server using the hvcg_iam_openapi_identity 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_iam_openapi_identity 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 QueryUserById
cargo run --example client QueryUsers
cargo run --example client DeleteUser

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
activate_user POST /mutation-api/identity-service/users/activation Activate a user
create-user POST /mutation-api/identity-service/users Create user
deactivate_user POST /mutation-api/identity-service/users/deactivation Deactive user
password-update PUT /mutation-api/identity-service/users/password-update password update
update_user PUT /mutation-api/identity-service/users/{id} Update an existing user
query-user-by-id GET /query-api/identity-service/users/{id} Get user infomation by id
query-users GET /query-api/identity-service/users Get users infomation
delete_user DELETE /mutation-api/identity-service/users/{id} Deletes a user

Documentation For Models

Documentation For Authorization

user_auth

  • Type: Bearer token authentication

Example

Author

Dependencies

~12–25MB
~356K SLoC