サーバーサイドエンジニアのいわむ(@k_iwamu)です！ 実は来月AWS re:Inventに参加してきます！弊社は海外カンファレンス補助が充実しているので、そういった配慮に感謝してたくさんのことを学んできます！
さて、社内ではFammを中心としたいくつかのサービスや社内システムで複数のAPIが開発されています。会社の規模も大きくなるにつれ、それぞれのサービスを社内のエンジニアで分担しながら作っています。
そうした中で、２つの課題があげられるようになりました。
- サービスごとにAPIドキュメントの運用方法やフォーマットが統一されておらず、管理が難しい状況になっている - APIドキュメントをホスティングするためにサーバーが立ち上がっており、その管理も必要になっている
そこで考えられた方針が、Swaggerを使ってドキュメントを統一化し、S3を使ってホスティングする方法です。理由は以下です。
- SwaggerはAPIドキュメントの標準フォーマットとして推進されている。 - S3はマネージドサービスであり、リソースの管理は不要である。さらにホスティングの設定も簡単に行える。
今回はその第一歩として、あるAPIに対して、Swagger + CircleCI + S3 を使ってAPIドキュメントを社内公開 + 自動更新 することを行いました。その作業をブログを通して紹介できればと思います！
