Presentation is loading. Please wait.

Presentation is loading. Please wait.

API Tooling An API is a contract.

Similar presentations


Presentation on theme: "API Tooling An API is a contract."— Presentation transcript:

1 API Tooling An API is a contract.
API usage is the key for long-term maintenance of software. Detection of potential breakage can help to prevent delays in SDK adoption. Different levels of exposure: API, SPI and internal code. Equinox Summit 2007

2 Terminology API: they are defined by the bundle manifest
SPI: limited to a reduced number of clients. Clients are aware that they are subject to change. Internal code: Should never be used. Speaking with WAS and WTP people, it seems that these definitions need some flexibility. Equinox Summit 2007

3 Use cases Backward compatibility: Detect changes that are not backward compatible ASAP Global references: who’s using my code and what am I using Version management: Make sure that the versioning scheme is respected according to the changes applied to a code base Equinox Summit 2007

4 Source Snapshots OSGi bundle Eclipse product Java JAR Update site
Filesystem Database API definition Queries Manifest.mf Javadoc tags Rules files Annotations Reports Reports Reports Equinox Summit 2007

5 + Existing PDE Api Tool Control structure Collect Source API Snapshot
NEW API Snapshot Control structure Compare OLD API Snapshot + Comparator XML Report HTML Report Equinox Summit 2007

6 http://sab39.netreach.com/Software/Japitools/42/ (GPL)
Existing tools Diff tool made by Jed Anderson PDE API tools prototype made by Oleg AUS (tool available on alphaworks) Open-source tool for jar comparison: (GPL) WTP tool (component.xml ?) JDiff (used by TPTP): Equinox Summit 2007


Download ppt "API Tooling An API is a contract."

Similar presentations


Ads by Google