Rustで始めるコードファーストなOpenAPI定義の生成 🦀

by TaKO8Ki

Slide 1

Slide 1 text

Rustで始めるコードファーストな OpenAPI定義の生成 🦀 Takayuki Maeda / TaKO8Ki

Slide 2

Slide 2 text

● Rust committer (member of compiler contributors team and diagnostic working group) ● Software Engineer @Moneyforward Takayuki Maeda / TaKO8Ki @TaKO8Ki @TaKOBKi

Slide 3

Slide 3 text

何を作っているか？

Slide 4

Slide 4 text

何を作っているか？ ref: https://corp.moneyforward.com/news/release/service/20230216-mf-press/

Slide 5

Slide 5 text

何を作っているか？国際規格「Peppol（ペポル）」とは、受発注や請求にかかる電子文書をネットワーク上でやり取りするための「文書仕様」「ネットワーク」「運用ルール」の規格で、国際的な非営利組織であるOPEN PEPPOLが管理しているグローバルな標準規格 

Slide 6

Slide 6 text

What is Peppol? ref: Introduction to Peppol AS4 12

Slide 7

Slide 7 text

What is Peppol? ref: Introduction to Peppol AS4 12 電子文書はXMLでやり取りされる

Slide 8

Slide 8 text

What is Peppol?

Slide 9

Slide 9 text

What is Peppol?

Slide 10

Slide 10 text

What is Peppol?

Slide 11

Slide 11 text

何を作っているか？自分がいるチームではこのSMPとAccess Pointのラッパー・請求書のvalidatorである Peppol APIをRustで開発している。 

Slide 12

Slide 12 text

コードファーストな OpenAPI定義の生成をしたい

Slide 13

Slide 13 text

コードファーストなOpenAPI定義の生成をしたい Peppol APIはマネーフォワードの各プロダクトで利用されるマイクロサービスなので、 RESTful APIのインターフェイスを定義したい。 

Slide 14

Slide 14 text

コードファーストなOpenAPI定義の生成をしたい Peppol APIはマネーフォワードの各プロダクトで利用されるマイクロサービスなので、 RESTful APIのインターフェイスを定義したい。加えてできるだけ実装と対応した定義にしたい。 

Slide 15

Slide 15 text

Invoice XML is complicated and has “161” elements and some attributes. コードからOpenAPI documentationを生成したい

Slide 16

Slide 16 text

コードファーストなOpenAPI定義の生成をしたいそこで便利なのが utoipa というcrate  utoipa - Simple, Fast, Code ﬁrst and Compile time generated OpenAPI documentation for Rust 

Slide 17

Slide 17 text

例えばこんな感じでattributeを使ってpathを定義できる

Slide 18

Slide 18 text

例えばこんな感じでattributeを使ってpathを定義できる

Slide 19

Slide 19 text

こんな感じでderiveを使ってschemaを定義できる

Slide 20

Slide 20 text

こんな感じでderiveを使ってschemaを定義できる

Slide 21

Slide 21 text

Doc用のstructをOpenApi deriveをつけて定義して、

Slide 22

Slide 22 text

Documentation用のstructをOpenApi deriveをつけて定義して、

Slide 23

Slide 23 text

こんな感じで定義を出力できます

Slide 24

Slide 24 text

もしくは、こんな感じでroutingを設定すると/swagger-uiでSwagger UIが見られる

Slide 25

Slide 25 text

コードファーストなOpenAPI定義の生成をしたい総じてすごく使いやすい。特にstructにattributeとしてdescriptionやexampleを書けるのがメンテナンスしやすくて良い。 

Slide 26

Slide 26 text

コードファーストなOpenAPI定義の生成をしたいただ気をつけないといけないこともある。   

Slide 27

Slide 27 text

コードファーストなOpenAPI定義の生成をしたい例えば、utoipaでは、$refでスキーマなどにアクセス可能かどうかは自分達で担保する必要がある。    > Note! Utoipa does not guarantee that free form ref is accessbile via OpenAPI doc or Swagger UI, users are eligible to make these guarantees.        ref: https://docs.rs/utoipa/latest/utoipa/attr.path.html#request-body-attributes

Slide 28

Slide 28 text

どういうことかというと、例えばこれは、

Slide 29

Slide 29 text

こうなって、

Slide 30

Slide 30 text

Tagをschemasに追加し忘れると存在しないschemaを参照してしまう

Slide 31

Slide 31 text

また例えば定義されていない型をbodyとして指定すると、

Slide 32

Slide 32 text

普通にコンパイルが通り、refになってしまう

Slide 33

Slide 33 text

コードファーストなOpenAPI定義の生成をしたい ToSchema derive、path attributeでは、ユーザーが定義したものについてはrefで参照するような実装になっている。つまり、すごく大きなStructなどを扱う時に全ての Struct・Enumをschemaとして追加しないといけない？ 

Slide 34

Slide 34 text

壊れにくいOpenAPI 定義を作るために

Slide 35

Slide 35 text

壊れにくいOpenAPI定義を作るためにまず、新しいpathやschemaを追加した時に、存在しないschemaを参照してOpenAPI 定義が壊れにくいようにしたい。 

Slide 36

Slide 36 text

そんな時に使えるのが #[schema(inlline)]。これをもとに定義を作ると、

Slide 37

Slide 37 text

こんな感じでtagがinline化される

Slide 38

Slide 38 text

壊れにくいOpenAPI定義を作るためにこれによって存在しないスキーマを参照することを防げる。    ただ個人的にはデフォルトがinlineでrefにしたい時だけ#[schema(ref)]にするみたいな実装の方がユーザ的には使いやすいんじゃないかと思う。結構大きな変更なのでプルリク投げるか難しいところ。 

Slide 39

Slide 39 text

壊れにくいOpenAPI定義を作るために次に、定義してない型を指定した時にコンパイルエラーになって欲しい。 

Slide 40

Slide 40 text

これも同じようにpathでinlineを使うことで一応防げる。下記はコンパイルエラーになる。

Slide 41

Slide 41 text

壊れにくいOpenAPI定義を作るために本当はinline無しでも定義してない型はコンパイルエラーになって欲しい。 

Slide 42

Slide 42 text

Invoice XML is complicated and has “161” elements and some attributes. じゃあなぜこういう実装になってるのか？

Slide 43

Slide 43 text

Invoice XML is complicated and has “161” elements and some attributes. ここで少し実装を覗いてみる

Slide 44

Slide 44 text

壊れにくいOpenAPI定義を作るためにまず、 cargo-expand でpathがどういうコードを生成するのか覗いてみる。 

Slide 45

Slide 45 text

No content

Slide 46

Slide 46 text

No content

Slide 47

Slide 47 text

No content

Slide 48

Slide 48 text

utoipa-gen/src/component.rs:746:759

Slide 49

Slide 49 text

utoipa-gen/src/component.rs:746:759 受け取ったpathをstringにそのnameを渡しているのでコンパイルエラーにならない。

Slide 50

Slide 50 text

Invoice XML is complicated and has “161” elements and some attributes. じゃあinlineの時はどうなってるか？

Slide 51

Slide 51 text

utoipa-gen/src/component.rs:726:740 type_pathがstringに変換されずにそのまま使われている

Slide 52

Slide 52 text

utoipa-gen/src/component.rs:726:740 type_pathがstringに変換されずにそのまま使われているじゃあこれをnot inlineでも実現すればいいのでは？

Slide 53

Slide 53 text

壊れにくいOpenAPI定義を作るために色々みるとpathのbodyなどには定義された型以外も渡ってくることが判明した。 

Slide 54

Slide 54 text

asを使って代替pathを設定でき、これがbodyとして使える。

Slide 55

Slide 55 text

asを使って代替pathを設定でき、これがbodyとして使えるこのケースでコンパイルエラーになってはいけない

Slide 56

Slide 56 text

壊れにくいOpenAPI定義を作るために最終的にbodyに定義されていない型が来たときにコンパイルエラーにする実装を途中まで書いていたところでこれに気づいて断念した。 

Slide 57

Slide 57 text

Invoice XML is complicated and has “161” elements and some attributes. 元の話に戻ります

Slide 58

Slide 58 text

壊れにくいOpenAPI定義を作るために壊れにくいOpenAPI定義を作るためにというか、openapi.yamlと実装に差分が出ないように別クレートを作ってunit testをその中に含めている。 

Slide 59

Slide 59 text

コードから生成したものと実際の openapi.ymlに差分があるかチェックし、あれば更新を促している。

Slide 60

Slide 60 text

まとめ

Slide 61

Slide 61 text

© Money Forward, Inc. まとめ ● Rustでは、utoipaを使ってコードファーストなOpenAPI定義の生成ができる。  ● utoipaは気をつけるべきポイントはあるが、総じて使いやすい。  ● 疑問点があったら実装を覗いてみて改善点があればパッチを投げてみるのが良さそう。    自分は最終的にtypo修正だけして終わりました。  https://github.com/juhaku/utoipa/pull/669 

Slide 62

Slide 62 text

Invoice XML is complicated and has “161” elements and some attributes. We are hiring!

Slide 63

Slide 63 text

No content