6B-01
スマートビル向けIoTデータ提供システムにおけるWebAPI更新効率化のためのOpenAPI仕様設計
○増田大輝,佐古田健志,田村亮太,溝口 侑,川添博史(東芝)
スマートビルではWebAPIによる設備データ活用が進む一方,データの追加に伴うAPI仕様の変更が頻発するため,運用コストが課題である.従来WebAPI開発では,単一のOpenAPI仕様書からドキュメントやコードを自動生成するが,仕様変更のたびに再生成されるコードの修正コストが高い.コード再生成を避けるためにOpenAPI仕様書のAPIパスを変数化する方法もあるが,この場合ドキュメント上のAPI一覧が抽象的な表示となり参照性が低下する.本稿では,ドキュメント用とコード生成用にOpenAPI仕様書を分離して運用することで,コードの修正を避けつつドキュメントの参照性を維持する手法を提案する.