Argentum 工具箱. REST 生成器。

REST 生成器是一个从 OpenAPI 规范创建 API 库的工具。

支持的生成器

[cols="1,3,1"] |=== |语言 | 类型 | 支持版本

|Rust |服务器端 API 包 |3.1 和 3

|===

主要功能

• 解析而非验证
• 生成的代码与 Argentum REST 兼容
• 清晰的、易于阅读的错误响应
• 生成代码中代码重复率低
• 可扩展和可重用的生成代码

如何安装

通过 cargo install

[source,shell]

cargo install argentum_rest_generator_app

.从源代码 .Clone [source,shell]

git clone [email protected]:argentum-toolkit/argentum.git

.安装二进制文件 [source,shell]

cargo install --path argentum_rest_generator_app/

如何使用

.生成 REST API 服务器库 [source,shell]

argentum_rest_generator_app --input api-doc/openapi.yaml --output rest/ --package-name user_account_rest

或者您可以通过 cargo run 生成（需要克隆源代码）

.示例 [source,shell]

cd argentum/argentum_rest_generator_app

cargo run --   --input ../argentum_user_account/api-doc/openapi.yaml --output ../argentum_user_account/rest/ --package-name argentum_user_account_rest

限制

• 如果 OpenAPI 对象支持 $ref 参数，则支持 $ref 参数。（在这种情况下不支持嵌入式对象）
• 模式仅支持对象类型（数组、AnyOf、AllOf 尚未实现）
• 我们不使用 OpenAPI 标签。如果您需要类似的功能，我们建议将您的 API 分割成包