電子情報通信学会ソサイエティ大会講演要旨
B-14-12
API仕様書生成技術に関する一考察
○小俣真吾(NTT)
OAS形式ではない仕様書で設計/開発された既存APIの仕様をOAS形式に変換する場合, 既存APIの仕様書やAPIリクエスト-レスポンスの内容を確認しながらOASを手書きで作成するか, 既存APIのリクエスト-レスポンスを基にOASを自動生成するツールを用いるのが一般的である. しかし, OASを自動生成するツールは, 簡易なOASフォーマットを生成するレベルであり, 設計書としては不十分とされる領域が存在する. そのため, 生成されたOAS仕様書を一通り確認し, 補足修正を加えて完成させている. つまり, 既存機能が提供するAPIの数が膨大である場合, 上述の不十分とされる領域次第では, 確認と修正稼働が膨大になる可能性がある. そこで本稿では, 既存技術の一つであるSwagger inspectorが, 既存APIのリクエスト-レスポンスから自動設計が不可であるパラメータ領域を明確にし, そのパラメータ毎に自動設計を可能にする為の処理方式を検討した.