Show TOC

Released APIsLocate this document in the navigation structure

The API state of a development object defines whether or not a development object can be used in development objects of other namespaces.

Overview

As of SAP NetWeaver AS for ABAP 7.51 innovation package SP00, you – as a developer – can check which APIs are released and stable for usage – and which are not. Consequently, customer objects that only use released APIs do not need to be adapted after the next SAP NetWeaver support package or upgrade.

The following object types can be classified and released:

  • Function modules
  • ABAP Dictionary objects
  • ABAP classes and interfaces
  • Type pools
  • XSLT transformations
  • BAdI definitions
  • CDS views
Visibility of APIs
Figure 1: Visibility of APIs

You can check the API state of development objects in the API State tab of the Properties view.

Tab for identifying an API state
Figure 2: Tab for identifying an API state
Finding and Identifying APIs

To find out which development objects are released, you have the following options:

Open ABAP Development Object Dialog

Perform Ctrl + Shift + A to open and filter for the relevant development objects that are released. In the Open dialog, enter api:released in the search string/filter criteria input field. The released objects are then listed in the Matching items: section.

Example of how to open released ABAP classes
Figure 3: Example of how to open released ABAP classes

ABAP Repository Tree / ABAP Repository Folder

Create or edit an ABAP repository tree or folder in order to display a predefined range of released development objects in the Project Explorer: Whenever you configure such a tree or folder, select the API State property for display.

If you enter api:released in the Property Filter input field, the released objects are then displayed.

Example of an ABAP repository tree filtered for the API state "Released"
Figure 4: Example of an ABAP repository tree filtered for the API state "Released"
API Check

To check the correct usage of released APIs, you can run code inspector checks in the integrated ABAP Test Cockpit (ATC).

Example of a finding in the ATC relating to the release state of an API
Figure 5: Example of a finding in the ATC relating to the release state of an API

In addition, you can define the ABAP language version of an ABAP program or class for each development object in the Properties view. This enables you to determine the scenario for which this object is used. Consequently, the relevant syntax check is considered for the visibility of an API.

Dropdown list box for defining the ABAP lanaguage version to be considered for the syntax check
Figure 6: Dropdown list box for defining the ABAP lanaguage version to be considered for the syntax check

Depending on the visibility, you can call these development objects in your custom projects or the syntax check displays an error.

Example of a code snippet from an ABAP program where an API at is not released is used
Figure 7: Example of a code snippet from an ABAP program where an API that is not released is used
Note

Currently, you need to configure the syntax check for each development object through the Specific tab of the Properties view. Here you must choose the relevant item from the ABAP Language Version dropdown listbox item for an API.

If you use APIs that are assigned to the same ABAP package as the consuming namespace, the syntax check will display no error – even if the API is not released.

Related Information