How to design a good API and why it matters

Bloch, Joshua

doi:10.1145/1176617.1176622

Cited by 141 publications

(132 citation statements)

References 0 publications

Supporting

Mentioning

126

Contrasting

Unclassified

Order By: Relevance

“…The inputs expExtractor are the statement sequence of the source code as an AST representation and the depth of the call hierarchy. First the algorithm iterates the statements in m. If ) If the statement itself is a composite block, we recursively go through the internal statements of the block, and extract the corresponding exception information (line [7][8][9][10]. If the statement invokes another method call, and m's argument(s) is(are) passed onto the callee method n, we will use the recursion with parameters -the statement body of the callee method as the parameter, together with the depth value decreased by 1 (line [12][13][14][15].…”

Section: A Extract Constraints From Api Source Codementioning

confidence: 99%

“…Precision is used to measure the exactness of the prediction set; recall measures the completeness. Precision and recall are calculated as follows 7 . F-measure considers both exactness and the completeness, and thus balances the precision and recall.…”

Section: A Settingsmentioning

confidence: 99%

“…Some initial research has been done, for instance, Saied et al enumerated categories of common API usage constraints and their documentation [6]. Undoubtedly, high-quality documentation is indispensable for the usability of APIs [7], [8], and we believe that a complete and correct documentation would be highly favourable by API users.…”

Section: Introduction Api (Application Programmingmentioning

confidence: 99%

See 2 more Smart Citations

Analyzing APIs Documentation and Code to Detect Directive Defects

Zhou

Chen

et al. 2017

2017 IEEE/ACM 39th International Conference on Software Engineering (ICSE)

View full text Add to dashboard Cite

Abstract-Application Programming Interface (API) documents represent one of the most important references for API users. However, it is frequently reported that the documentation is inconsistent with the source code and deviates from the API itself. Such inconsistencies in the documents inevitably confuse the API users hampering considerably their API comprehension and the quality of software built from such APIs. In this paper, we propose an automated approach to detect defects of API documents by leveraging techniques from program comprehension and natural language processing. Particularly, we focus on the directives of the API documents which are related to parameter constraints and exception throwing declarations. A first-order logic based constraint solver is employed to detect such defects based on the obtained analysis results. We evaluate our approach on parts of well documented JDK 1.8 APIs. Experiment results show that, out of around 2000 API usage constraints, our approach can detect 1146 defective document directives, with a precision rate of 81.6%, and a recall rate of 82.0%, which demonstrates its practical feasibility.

show abstract

Section: A Extract Constraints From Api Source Codementioning

confidence: 99%

Section: A Settingsmentioning

confidence: 99%

Section: Introduction Api (Application Programmingmentioning

confidence: 99%

See 1 more Smart Citation

Analyzing APIs Documentation and Code to Detect Directive Defects

Zhou

Chen

et al. 2017

2017 IEEE/ACM 39th International Conference on Software Engineering (ICSE)

View full text Add to dashboard Cite

show abstract

“…In developing a system such as this there is an emphasis on creating an system which can be reused and not limited to a one time use [28]. The objective of the present work is to provide a campus guidance system for the delegates attending the China-Ireland Conference on Informations and Communication Technologies 2009 [29].…”

Section: Using Web-based Maps Apimentioning

confidence: 99%

Campus Guidance System for International Conferences Based on OpenStreetMap

Jacob

Zheng

Ciepłuch

et al. 2009

Web and Wireless Geographical Information Systems

View full text Add to dashboard Cite

Abstract. We present a web-based, multi-lingual, campus guidance system with emphasis on pedestrian navigation aimed at providing support for delegates attending International Conferences at the National University of Ireland Maynooth (NUIM) campus. A special campus guidance system could improve the logistics of the conference and potentially attract more delegates to the conference. The Cloudmade Web Map Lite API which uses OpenStreetMap has been used for creating this interface. The system generates shortest pedestrian paths using both outdoor pavements and indoor corridors between various buildings and points of interests (POI). For visual assistance in pedestrian navigation geotagged images are used along the path at certain points in the route, such as road intersections, when the user needs to get their orientation correct. The interface is currently available in both English and Chinese language.

show abstract

“…Only recently has API [1] design 1 been recognized as a challenging and important task that is critical to the minimal yet functional access to the components of a system. Although it has been years since the dependency inversion principle was advocated, far too many class libraries and frameworks force developers to reach into the framework and/or import all sorts of irrelevant dependents, etc.…”

Section: Soa Services Means Interfaces Are Important Therefore Servicmentioning

confidence: 99%

SOA and the Clash of Technocultures Classes versus Infosets versus Business Process.

Thomas¹

2007

JOT

View full text Add to dashboard Cite

How to design a good API and why it matters

Cited by 141 publications

References 0 publications

Analyzing APIs Documentation and Code to Detect Directive Defects

Analyzing APIs Documentation and Code to Detect Directive Defects

Campus Guidance System for International Conferences Based on OpenStreetMap

SOA and the Clash of Technocultures Classes versus Infosets versus Business Process.

Contact Info

Product

Resources

About