OpenAPIからのRustクライアントコード生成 2024-07-24 Rust、何もわからない…#13 @matsu7874 #Rust何もわからない

matsu7874 株式会社estieでソフトウェアエンジニアをしています。 RustでWebアプリケーションを開発しています。 自己紹介 © 2024 estie, Inc. 1

OpenAPI Generatorを使おう これで必要なブロックが揃います。 npm install @openapitools/openapi-generator-cli -g openapi-generator-cli generate -i api.yaml -g rust -o generated-client 結論 © 2024 estie, Inc. 2

1. 今回は使う側の話 2. OpenAPI周りのツール群 3. OpenAPI Generator 目次 © 2024 estie, Inc. 3

1. 今回は使う側の話

schema first VS code first　の話ではない Rustでバックエンドを書く部分では code first なcrateを使っている async_graphql paperclip 1. 今回は使う側の話 © 2024 estie, Inc. 5

他の言語で開発されたAPIをRustから使いたい 基盤チームが開発してくれているAPIをプロダクトから使いたい OpenAPI 3.1.0形式でAPI仕様を共有している 今後も基盤の開発が続きそうで、API仕様が変わるかもしれない 1. 今回は使う側の話 © 2024 estie, Inc. 6

2. OpenAPI周りのツール群

今回の用途に適したものがない utoipa Rust->OpenAPIの変換ツール paperclip OpenAPI 3.1.0形式に対応していない Progenitor OpenAPI 3.1.0形式に対応していない Swagger Codegen jarファイルが必要？未検証 2. OpenAPI周りのツール群 © 2024 estie, Inc. 8

3. OpenAPI Generator

Webエンジニアにとってインストールが簡単 npm install @openapitools/openapi-generator-cli -g 3. OpenAPI Generator © 2024 estie, Inc. 10

コード生成も簡単 openapi-generator-cli generate -i api.yaml -g rust -o generated-client 3. OpenAPI Generator © 2024 estie, Inc. 11

生成されたファイル群 generated-client ├── Cargo.toml ├── README.md ├── docs │ └── モデルに対応するドキュメント.md ├── git_push.sh └── src ├── apis │ ├── configuration.rs │ ├── default_api.rs │ └── mod.rs ├── lib.rs └── models ├── mod.rs └── モデルごとの.rs 3. OpenAPI Generator © 2024 estie, Inc. 12

生成されたコードの使い方 use chat::{apis, models}; #[tokio::main] async fn main() { let mut config = apis::configuration::Configuration::new(); let request = models::Chat::new(vec![ models::ChatRequestMessagesInner::ChatMessageParam(Box::new( "接続成功してくれ！！！！！！！".to_string(), )), ]); let result = apis::default_api::chat_api_post( &config, request, ).await; } 3. OpenAPI Generator © 2024 estie, Inc. 13

OpenAPI Generatorの弱点 Rust向けに対応していない項目もある anyOf 未対応 oneOf は対応済み https://openapi-generator.tech/docs/generators/rust/ 3. OpenAPI Generator © 2024 estie, Inc. 14

まとめ

OpenAPI Generatorを使おう RustでOpenAPIを使う際にはOpenAPI Generatorを使うのが簡単 一部対応していない項目はあるが 生成されたコードを使ってAPI呼び出し部分を実装しよう まとめ © 2024 estie, Inc. 16