Skip to content

Commit

Permalink
Update readme to include grpc and generic function service
Browse files Browse the repository at this point in the history
  • Loading branch information
spencewenski committed Jun 7, 2024
1 parent 31c0e65 commit 277ca04
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,17 @@ and [Poem](https://github.com/poem-web/poem).

- Built on Tokio's web stack (axum, tower, hyper, tracing). App behavior can be easily extended by taking advantage of
all the resources in the tokio ecosystem.
- Provides sane defaults so you can focus on building your app.
- Most of the built-in behavior can be customized or even disabled via per-environment configuration files.
- Built-in support for HTTP APIs via [Axum](https://crates.io/crates/axum) (with the `http` feature) and gRPC APIs
via [Tonic](https://crates.io/crates/tonic) (with the `grpc` feature).
- Auto-generates an OpenAPI schema for HTTP API routes defined with [aide](https://crates.io/crates/aide) (requires
the `open-api` feature).
- Support for running arbitrary long-running services (e.g., an API format not supported out of the box) with minimal
boilerplate. Simply provide a
[FunctionService](https://docs.rs/roadster/latest/roadster/service/function/service/struct.FunctionService.html)
with your async function and register it in the `App#services` method.
- Provides sane defaults so you can focus on building your app, but most (all?) of the built-in behavior can be
customized or disabled via per-environment configuration files.
- Uses `#![forbid(unsafe_code)]` to ensure all code in Roadster is 100% safe rust.
- Auto-generates an OpenAPI schema for routes defined with [aide](https://crates.io/crates/aide) (requires
the `open-api` feature)
- Provides a CLI for common commands, and allows consumers to provide their own CLI commands
using [clap](https://crates.io/crates/clap) (requires the `cli` feature)
- Provides sample JWT extractor for Axum (requires the `jwt-ietf` and/or `jwt-openid` features). Also provides a general
Expand Down

0 comments on commit 277ca04

Please sign in to comment.