#axum #routing #handler #macro #typed

axum-typed-routing

为 axum 提供的静态类型路由宏

5 个版本

0.2.1 2024年2月23日
0.2.0 2024年2月10日
0.1.2 2024年1月5日
0.1.1 2024年1月5日
0.1.0 2024年1月5日

1288Web编程

Download history 2/week @ 2024-03-13 1/week @ 2024-03-27 3/week @ 2024-05-08 12/week @ 2024-05-15 4/week @ 2024-05-22 182/week @ 2024-05-29 150/week @ 2024-06-05 155/week @ 2024-06-12 112/week @ 2024-06-19 127/week @ 2024-06-26

每月602次下载

MIT/Apache

18KB
155

Crates.io Documentation

Axum-typed-routing

使用宏在 axum 中创建静态类型处理器的库,类似于使用 aide 支持OpenAPI的 Rocket。

有关更多信息,请参阅文档


lib.rs:

基本用法

以下示例演示了库的基本用法。在任何一个常规处理器之上,您可以添加 route 宏来创建一个类型路由。URL 中的任何路径或查询参数都将进行编译时类型检查,并正确提取到处理器中。

以下示例显示了路径参数 id 以及查询参数 amountoffset 如何进行类型检查并提取到处理器中。

以下是一些有效的 get 方法 URL:

  • /item/1?amount=2&offset=3
  • /item/1?amount=2
  • /item/1?offset=3
  • /item/500

amountoffset 参数标记为 Option<T>,它们变为可选的。

使用 aide 的示例

当启用 aide 功能时,可以为路由自动生成 OpenAPI 文档。使用 api_route 宏代替 route 宏。

有关用法更多信息,请参阅 aide 文档。

依赖项

~5–8.5MB
~133K SLoC