An Empirical Study on the Reliability of the Web API Document

Masaki Hosono, Hironori Washizaki, Yoshiaki Fukazawa, Kiyoshi Honda

研究成果: Conference contribution

抄録

The importance of APIs in software development, especially web APIs, has increased Developers read documentation, which is available on the internet, and use the corresponding APIs in their products. However, documentation occasionally contains mistakes. Such mistakes can confuse developers or lead to defects that lower the quality of the product. In this paper, we investigate the reliability of web APIs by extracting and comparing OpenAPI specifications from both the documentations and the results of the API calls. Almost half of the documentations are somehow unreliable. Mismatches between documentation and the response can be categorized into four types: 1) Undocumented Keys, 2) Dynamic Keys, 3) Unreturned Keys, and 4) Type Mismatched. This study will help developers design more reliable products.

本文言語English
ホスト出版物のタイトルProceedings - 25th Asia-Pacific Software Engineering Conference, APSEC 2018
出版社IEEE Computer Society
ページ715-716
ページ数2
ISBN(電子版)9781728119700
DOI
出版ステータスPublished - 2018 7 2
イベント25th Asia-Pacific Software Engineering Conference, APSEC 2018 - Nara, Japan
継続期間: 2018 12 42018 12 7

出版物シリーズ

名前Proceedings - Asia-Pacific Software Engineering Conference, APSEC
2018-December
ISSN(印刷版)1530-1362

Conference

Conference25th Asia-Pacific Software Engineering Conference, APSEC 2018
国/地域Japan
CityNara
Period18/12/418/12/7

ASJC Scopus subject areas

  • ソフトウェア

フィンガープリント

「An Empirical Study on the Reliability of the Web API Document」の研究トピックを掘り下げます。これらがまとまってユニークなフィンガープリントを構成します。

引用スタイル