Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions shenyu-client-rust/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Apache ShenYu-Client-Rust

The Apache `ShenYu` Rust Client SDK is a Rust library for interacting with the Apache `ShenYu` gateway. This SDK allows you to easily integrate your Rust applications with the `ShenYu` gateway, providing a seamless way to manage and route your API requests.

## Installation

To use the Apache `ShenYu` Rust Client SDK in your project, add the following dependencies to your `Cargo.toml` file:

```toml
[dependencies]
serde = "1.0.190"
serde_json = "1.0.80"
reqwest = "0.12.5"
axum = "0.5"
tokio = "1.39.3"
shenyu-client-rust = {version = "0.1.1", features = ["actix-web", "axum"] }
```

## Usage

Below is an example of how to create an Axum service using `ShenYuRouter` and integrate it with the `ShenYu` Gateway.

### Example

See [examples](https://github.com/apache/shenyu-client-rust/tree/main/examples).

This example demonstrates how to set up a basic Axum service using `ShenYuRouter` and register it with the `ShenYu` Gateway. `health_handler` and `create_user_handler` are simple asynchronous functions that handle HTTP requests.

## License

This project is licensed under the Apache License 2.0. For more details, see the [LICENSE](LICENSE) file.
2 changes: 1 addition & 1 deletion shenyu-client-rust/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
clippy::separated_literal_suffix, // conflicts with clippy::unseparated_literal_suffix
clippy::single_char_lifetime_names, // TODO: change lifetime names
)]
#![doc = include_str!("../../README.md")]
#![doc = include_str!("../README.md")]

use crate::model::UriInfo;

Expand Down
Loading