現状 / 課題 APIが増えてきたのでドキュメント化したい またTypeScript を導入したので、api レスポンス Type を生成したい Type を手動で書くなら ドキュメントの schema から生成したら楽そう バックエンドは Rspec をしているので自動で schema 生成 ⇨ schema から type 生成すればいいのでは? いい感じの型が生成されない。自動生成 schema の限界がある? そもそももっと良い開発フロー & いい感じのフロー移行方法があるか?今ここ
こんにちは、SmartHR でフロントエンド開発を担当している @Tokky0425 です。 この記事では、私のプロダクトでの OpenAPI Generator を使ったフロントエンド開発の取り組みを紹介していきます。 目次 OpenAPI とは 「ラクラク分析レポート」の DX 上の課題 OpenAPI Generator とは 実際に generate してみる 生成ファイルを使ってみる 型情報を出力してみる 組み込み・運用の工夫 chokidar で監視する lint-staged に組み込む メリット・デメリット メリット デメリット まとめ OpenAPI とは OpenAPI とは、「REST API のドキュメントの記述形式を定めた仕様」のことを指しています。 簡単な例ですが、下記のような YAML ファイルがあるとします。 schema.yml paths: "/some
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く