Inappropriate Usage Examples in Web API Documentations

Masaki Hosono, Susumu Tokumoto, Supasit Monpratarnchai, Hironori Washizaki, Kiyoshi Honda, Hiromasa Nagumo, Hisanobu Sonoda, Yoshiaki Fukazawa, Kazuki Munakata, Takao Nakagawa, Yusuke Nemoto

研究成果: Conference contribution

抄録

Application Programming Interfaces (APIs) are common in software development to reuse other products. Although the documentation allows API consumers to learn about API usages, it can be unreliable. Here, we investigate the characteristics of inappropriate usage examples in web API documentation by extracting and comparing OpenAPI Specifications from usage example-response pairs. About 65.5% of the endpoints have some form of inappropriate usage examples. Furthermore, mismatches are classified into four categories: Undocumented keys pattern, dynamic keys pattern, unreturned keys pattern, and type mismatched pattern. Our results suggest that the number of keys in the response is correlated with the number of mismatches. These findings should assist both API providers and consumers who deal with unreliable documentation in web APIs.

本文言語English
ホスト出版物のタイトルProceedings - 2019 IEEE International Conference on Software Maintenance and Evolution, ICSME 2019
出版社Institute of Electrical and Electronics Engineers Inc.
ページ343-347
ページ数5
ISBN(電子版)9781728130941
DOI
出版ステータスPublished - 2019 9
イベント2019 IEEE International Conference on Software Maintenance and Evolution, ICSME 2019 - Cleveland, United States
継続期間: 2019 9 302019 10 4

出版物シリーズ

名前Proceedings - 2019 IEEE International Conference on Software Maintenance and Evolution, ICSME 2019

Conference

Conference2019 IEEE International Conference on Software Maintenance and Evolution, ICSME 2019
国/地域United States
CityCleveland
Period19/9/3019/10/4

ASJC Scopus subject areas

  • ソフトウェア
  • 安全性、リスク、信頼性、品質管理

フィンガープリント

「Inappropriate Usage Examples in Web API Documentations」の研究トピックを掘り下げます。これらがまとまってユニークなフィンガープリントを構成します。

引用スタイル