2026-04-15T00:24:12Z https://ipsj.ixsq.nii.ac.jp/oai

oai:ipsj.ixsq.nii.ac.jp:00217305 2025-01-19T15:32:47Z 1164:1384:10896:10897

Web APIの進化及び伴うドキュメントの改訂に見られる傾向に関する定量的調査 園田, 尚宣 鷲崎, 弘宜 深澤, 良彰 運用・保守 2000 年頃から広く使われるようになった Web API においても，旧来の API 同様ドキュメントの重要性は非常に大きい．しかし，Web API ドキュメントに関しての研究は発展途上である．本研究では Web API の進化および伴うドキュメントの改訂の傾向について定量的に明らかにすることを目指す．そのために，git で管理されたドキュメントの変更履歴から JSON Patch を生成し，これらを用いて実証研究を行った．本研究の結果として，Web API ドキュメントの改訂の傾向としてパラメータに関する更新が非常に多いことが分かった．また，ドキュメントに含まれる自然言語記述や利用例は頻繁に改定されていることも分かった．Web API の進化においては利用者が受け取るデータに関する変更があるとバージョンの変化がある一方で，利用者が送信するデータの変更の際にはバージョンが変化しない傾向が見られた．Web API 利用者にはドキュメントを繰り返し閲覧することを推奨する． technical report 情報処理学会 2022-03-04 application/pdf 研究報告ソフトウェア工学（SE） 19 2022-SE-210 1 8 2188-8825 AN10112981 https://ipsj.ixsq.nii.ac.jp/record/217305/files/IPSJ-SE22210019.pdf jpn