APIドキュメントをRedocで一新しました | AQ Tech Blog

概要 AQに入社して2年目、デジタルエンジニアリング部デジタルエンジニアリング1課の松浦です。 本記事は、私が携わったとある案件で利用していたAPIドキュメントを整備した際の記録です。 APIドキュメントの管理に困っている方の参考になればと思います。 導入経緯 もともとスプレッドシートで管理していたのですが、スプレッドシートの管理だと、差分を見るのが大変だったり、他社に利用してもらいにくいなど不便な点がありました。 またOpenAPIの仕様に合わせた記述をしたいという要望があったため、YAML + OpenAPIでの管理へ移行することとなりました。 導入ライブラリの選定基準 OpenAPIへの記述へ移行するに当たり、YAMLで書いた仕様書を何かしらの方法でレンダリングする必要がありました。候補としては、Redoc、Swagger UIが上がり、当初はSwagger UIを導入する予定だった