Fast and Type-Safe OpenAPI implementation for Poem.
Poem-openapi
allows you to easily implement APIs that comply with the OpenAPIv3
specification.
It uses procedural macros to generate a lots of boilerplate code, so that you only need to focus on the more
important business implementations.
To avoid compiling unused dependencies, Poem gates certain features, all of which are disabled by default:
|Feature |Description |
|------------------|--------------------------------|
|chrono | Integrate with the chrono
crate. |
```rust use poem_openapi::{payload::PlainText, OpenAPI, API};
struct Api;
impl Api {
#[oai(path = "/", method = "get")]
async fn index(&self, #[oai(name = "name", in = "query")] name: Option
async fn main() { poem::Server::bind("127.0.0.1:3000") .await .unwrap() .run(OpenAPI::new(Api).title("hello World").ui_path("/ui")) .await .unwrap(); } ```
Open http://localhost:3000/ui
in your browser, you will see the Swagger UI
that contains these API definitions.
```shell
cargo run --example hello_world
curl http://localhost:3000 hello!
curl http://localhost:3000\?name\=sunli hello, sunli!
```