Article

Inferring Web API Descriptions from Usage Data

Authors:

Philippe Suter,

Erik WitternAuthors Info & Claims

HOTWEB '15: Proceedings of the 2015 Third IEEE Workshop on Hot Topics in Web Systems and Technologies (HotWeb)

Pages 7 - 12

https://doi.org/10.1109/HotWeb.2015.19

Published: 12 November 2015 Publication History

Abstract

We describe a set of techniques to infer structured descriptions of web APIs from usage examples. Using trained classifiers, we identify fixed and variable segments in paths, and tag parameters according to their types. We implemented our techniques and evaluated their precision on 10 APIs for which we obtained: 1) descriptions, manually written by the API maintainers, and 2) server logs of the API usage. Our experiments show that our system is able to reconstruct the structure of both simple and complex web API descriptions, outperforming an existing tool with similar goals. Finally, we assess the impact of noise in the input data on the results of our method.

Cited By

View all

Lamothe MGuéhéneuc YShang W(2021)A Systematic Review of API Evolution LiteratureACM Computing Surveys10.1145/347013354:8(1-36)Online publication date: 4-Oct-2021
https://dl.acm.org/doi/10.1145/3470133
Yang JWittern EYing ADolby JTan LZaidman AKamei YHill E(2018)Towards extracting web API specifications from documentationProceedings of the 15th International Conference on Mining Software Repositories10.1145/3196398.3196411(454-464)Online publication date: 28-May-2018
https://dl.acm.org/doi/10.1145/3196398.3196411
Aué JAniche MLobbezoo Mvan Deursen APaulisch FBosch J(2018)An exploratory study on faults in web API integration in a large-scale payment companyProceedings of the 40th International Conference on Software Engineering: Software Engineering in Practice10.1145/3183519.3183537(13-22)Online publication date: 27-May-2018
https://dl.acm.org/doi/10.1145/3183519.3183537
Show More Cited By

Recommendations

Eclipse API usage: the good and the bad

Today, when constructing software systems, many developers build their systems on top of frameworks. Eclipse is such a framework that has been in existence for over a decade. Like many other evolving software systems, the Eclipse platform has both ...
Generating Open API Usage Rule from Error Descriptions
SOSE '13: Proceedings of the 2013 IEEE Seventh International Symposium on Service-Oriented System Engineering

Open API platform is a trend for many leading social networks and e-business internet enterprises to publish services. The third-party developers can build their own applications interacting with Open platform via the Open API. The APIs have rules on the ...
Analyzing the Eclipse API Usage: Putting the Developer in the Loop
CSMR '13: Proceedings of the 2013 17th European Conference on Software Maintenance and Reengineering

Eclipse guidelines distinguish between two types of interfaces provided to third-party developers, i.e., APIs and non-APIs. APIs are stable and supported, while non-APIs are unstable, unsupported and discouraged as they are subject to arbitrary change ...

Comments

Please enable JavaScript to view thecomments powered by Disqus.

Information & Contributors

Information

Published In

HOTWEB '15: Proceedings of the 2015 Third IEEE Workshop on Hot Topics in Web Systems and Technologies (HotWeb)

November 2015

98 pages

ISBN:9781467396882

Publisher

IEEE Computer Society

United States

Publication History

Published: 12 November 2015

Qualifiers

Article

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

5
Total Citations
View Citations
0
Total Downloads

Downloads (Last 12 months)0
Downloads (Last 6 weeks)0

Reflects downloads up to 06 Jan 2025

Other Metrics

View Author Metrics

Citations

Cited By

View all

Lamothe MGuéhéneuc YShang W(2021)A Systematic Review of API Evolution LiteratureACM Computing Surveys10.1145/347013354:8(1-36)Online publication date: 4-Oct-2021
https://dl.acm.org/doi/10.1145/3470133
Yang JWittern EYing ADolby JTan LZaidman AKamei YHill E(2018)Towards extracting web API specifications from documentationProceedings of the 15th International Conference on Mining Software Repositories10.1145/3196398.3196411(454-464)Online publication date: 28-May-2018
https://dl.acm.org/doi/10.1145/3196398.3196411
Aué JAniche MLobbezoo Mvan Deursen APaulisch FBosch J(2018)An exploratory study on faults in web API integration in a large-scale payment companyProceedings of the 40th International Conference on Software Engineering: Software Engineering in Practice10.1145/3183519.3183537(13-22)Online publication date: 27-May-2018
https://dl.acm.org/doi/10.1145/3183519.3183537
Wittern EYing AZheng YLaredo JDolby JYoung CSlominski ANadi SNguyen TNguyen HAmann S(2017)Opportunities in software engineering research for web API consumptionProceedings of the 1st International Workshop on API Usage and Evolution10.5555/3106028.3106033(7-10)Online publication date: 20-May-2017
https://dl.acm.org/doi/10.5555/3106028.3106033
Wittern EYing AZheng YDolby JLaredo JUchitel SOrso ARobillard M(2017)Statically checking web API requests in JavaScriptProceedings of the 39th International Conference on Software Engineering10.1109/ICSE.2017.30(244-254)Online publication date: 20-May-2017
https://dl.acm.org/doi/10.1109/ICSE.2017.30

Abstract

Cited By

Recommendations

Eclipse API usage: the good and the bad

Generating Open API Usage Rule from Error Descriptions

Analyzing the Eclipse API Usage: Putting the Developer in the Loop

Comments

Information

Published In

Publisher

Publication History

Qualifiers

Contributors

Other Metrics

Bibliometrics

Article Metrics

Other Metrics

Citations

Cited By

View options

Figures

Other

Share

Share this Publication link

Share on social media

Affiliations