Recommended
More Related Content
Similar to IOTS2021発表スライド：オントロジーを用いたOpenAPI Documentの制約推薦システム
Similar to IOTS2021発表スライド：オントロジーを用いたOpenAPI Documentの制約推薦システム (20)
Recently uploaded
Recently uploaded (9)
IOTS2021発表スライド：オントロジーを用いたOpenAPI Documentの制約推薦システム
- 1. オントロジーを用いた OpenAPI Documentの制約推薦システム 第14回インターネットと運用技術シンポジウム（IOTS 2021) 柴田 晃 / 大阪市立大学大学院工学研究科 石橋 勇人 / 大阪市立大学大学院工学研究科
- 3. 背景と目的
- 4. RESTful API •Web APIに良く利用されている •RESTと呼ばれるアーキテクチャに沿って構築 • URIでリソースを指定 • HTTPのメソッドでリソースを操作 POST /api/user HTTP/1.1 Host: example.com Content-Type: application/json cache-control: no-cache { "name":"Shibata" } Client Server 図1: Shibataユーザーを作成するRESTful APIのリクエスト例 Shibataユーザーの作成
- 5. OpenAPI Document •APIの仕様書 • OpenAPI Specification (OAS)を用いて記述 • フォーマットはYAMLまたはJSON •広く利用されている •テストケースを生成する研究に使われている[1][2] • パラメータの制約に関する問題がある [1] Ed-douibi, H., Canovas Izquierdo, J. L. and Cabot, J.: Automatic Generation of Test Cases for REST APIs: A Specification-Based Approach, 2018 IEEE 22nd International Enterprise Distributed Object Computing Conference (EDOC), IEEE, pp. 181–190 (2018). [2] 柴田 晃，石橋勇人: QA テストのアクセスログを用いた Web システム負荷試験生成システムの提案，インター ネッ トと運用技術シンポジウム論文集，pp. 103–104 (2020).
- 6. OpenAPI Documentの問題 •パラメータの制約記述が不足 • 説明として書かれている • 制約が書かれていない •ドキュメントに存在しない制約が実装されている • ドキュメントと実装にずれ • ドキュメント記述者や参照者の想定とは異なる実装の可能 性
- 7. なぜ制約が書かれていないのか？ •記述者の怠慢である •記述者にとっては自明 • メールアドレスなど • 実装は複数のパターンが考えられる •メールアドレスのフォーマット（制約） • /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a- zA-Z0-9-]+)*$/ • /A[w+-.]+@[a-zd-.]+.[a-z]+z/ • /.+@.+¥..+/
- 8. 本研究の目的 •制約がOASの記法にそって不足無く記述される状態に する • OASの記法を拡張する等のアプローチは取らない •OpenAPI Documentの記述者を支援システムを実装 • 不足している制約を発見する • 記述するべき制約の種類と値を推薦する
- 9. 提案システム
- 10. 提案システム •WebAPIに関するオントロジーをもとに，OpenAPI Documentに不足している制約の発見と推薦を行う • 開発者は書かれていない制約を実装している • 知識をもとに制約を判断している • 人と同じように知識を元に制約を発見したい • 人の知識をシステムで扱うための表現＝オントロジー
- 11. 提案システムの概要 •OpenAPI Documentからパラメータの定義を取得 •個々のパラメータをオントロジーにマッピング •制約を発見し，不足している制約を推薦する (1) OpenAPI Document (2) OpenAPI Document (3) (4) OpenAPI Document OpenAPI 図2: 提案システムの概要
- 13. リスト2: NewPetスキームの 定義 OpenAPI Documentの例 リスト1: 新しいペットを登録するAPIの定義
- 14. 提案システムで利用するオントロジー •パラメータプロパティ • パラメータの制約 •APIパラメータ • パラメータの概念 •パラメータ型 • パラメータのデータ型 図3: 提案システムで利用するオントロジーの一部
- 19. 制約の検索の流れ 図3: オントロジーとOpenAPI Documentのマッピングと制約の検索例 (3) Nameクラスが所有する制約 （hasPropertyで繋がるクラス） を探す
- 20. 動作検証
- 23. まとめと今後の展望
- 24. まとめ •本研究では，Web APIのパラメータに関するオントロ ジーをもとに，OpenAPI Documentに不足している制 約の発見と推薦を行うシステムを提案した． •提案手法では，OpenAPI Documentに定義されたパラ メータの型情報から，不足している制約を発見推薦し ている． •動作検証から，不足している制約は発見できることは 確認したが，オントロジーに定義されている情報が少 なく，制約にどのような値を設定すると良いかの推薦 ができていない．
- 25. 今後の展望 •オントロジーの拡充 • 推薦できる値を増やす •検索条件の追加 • 型情報以外の情報も組み合わせる •提示インターフェースの実装 • OpenAPI Documentの記述者に制約を提示する
- 27. まとめ •本研究では，Web APIのパラメータに関するオントロ ジーをもとに，OpenAPI Documentに不足している制 約の発見と推薦を行うシステムを提案した． •提案手法では，OpenAPI Documentに定義されたパラ メータの型情報から，不足している制約を発見推薦し ている． •動作検証から，不足している制約は発見できることは 確認したが，オントロジーに定義されている情報が少 なく，制約にどのような値を設定すると良いかの推薦 ができていない．
- 28. Appendix
- 29. オントロジーの展望 •オントロジーを用いる ことで次のような推薦を行うこ とができる • instance-id というパラメータ定義があった時，Amazon WebServices(AWS)の知識から「^i-[0-9a-z]{17}$」 というパ ターンを制約として推薦する • name(氏名)，surname(氏)，given name(名)という パラメー タ定義があった時，パラメータ間の関係と氏 名に関する知 識から surname の最大長と given name の最大長を足した 値が，name の文字数の最大長を越 えないように推薦する
Editor's Notes
- 6:25
- 9:20
- 12:00
- 16:20
- 18:05