Automatically Extracting Web API Specifications from HTML Documentation

01/26/2018
by   Jinqiu Yang, et al.
0

Web API specifications are machine-readable descriptions of APIs. These specifications, in combination with related tooling, simplify and support the consumption of APIs. However, despite the increased distribution of web APIs, specifications are rare and their creation and maintenance heavily relies on manual efforts by third parties. In this paper, we propose an automatic approach and an associated tool called D2Spec for extracting specifications from web API documentation pages. Given a seed online documentation page on an API, D2Spec first crawls all documentation pages on the API, and then uses a set of machine learning techniques to extract the base URL, path templates, and HTTP methods, which collectively describe the endpoints of an API. We evaluated whether D2Spec can accurately extract endpoints from documentation on 120 web APIs. The results showed that D2Spec achieved a precision of 87.5 identifying base URLs, a precision of 81.3 path templates, and a precision of 84.4 HTTP methods. In addition, we found that D2Spec was useful when applied to APIs with pre-existing API specifications: D2Spec revealed many inconsistencies between web API documentation and their corresponding publicly available specifications. Thus, D2Spec can be used by web API providers to keep documentation and specifications in synchronization.

READ FULL TEXT

page 1

page 2

page 3

page 4

research
05/24/2023

Carving UI Tests to Generate API Tests and API Specification

Modern web applications make extensive use of API calls to update the UI...
research
08/28/2020

A First Look at the Deprecation of RESTful APIs: An Empirical Study

REpresentational State Transfer (REST) is considered as one standard sof...
research
11/12/2018

Modern RESTful API DLs and frameworks for RESTful web services API schema modeling, documenting, visualizing

The given paper presents an overview of modern RESTful API description l...
research
06/24/2011

Wrapper Maintenance: A Machine Learning Approach

The proliferation of online information sources has led to an increased ...
research
03/10/2021

FiLiPo: A Sample Driven Approach for Finding Linkage Points between RDF Data and APIs (Extended Version)

Data integration is an important task in order to create comprehensive R...
research
03/18/2019

Benchmarking Web API Quality - Revisited

Modern applications increasingly interact with web APIs - reusable compo...
research
06/19/2019

A survey of OpenRefine reconciliation services

We review the services implementing the OpenRefine reconciliation API, c...

Please sign up or login with your details

Forgot password? Click here to reset