ABAP-Swagger
An ABAP library that exposes a class's public methods as REST services, registered through the ZIF_SWAG_HANDLER interface, with a Swagger UI on the same base path describing them.
Exposing ABAP logic as a REST API otherwise means wiring up the HTTP handling separately from documenting it. ABAP-Swagger takes a class with public methods, implements the ZIF_SWAG_HANDLER interface to register them, and makes those methods reachable over REST; the same base path serves a Swagger UI through swagger.html so the API is described the same way it is exposed. It is installed via abapGitabapGitA Git client written in ABAP that runs inside the system, so objects are cloned, pulled and pushed without leaving it; with no package manager in ABAP, a cloned repository is how code is distributed.community org, abap and needs native JSON support.
Facts
Where it sits
Who is behind it
In the atlas: maintains 13, contributes to 92, wrote 1@larshpmaintainerBinaegContributes to this
In the atlas: contributes to 1@BinaegJens SchwarzContributes to this
In the atlas: contributes to 4@BlackmanCCJohannes KoningsContributes to this
In the atlas: contributes to 7@JohannesKoningsJaime Rodriguez CapoteContributes to this
In the atlas: maintains 1, contributes to 9@jrodriguez-rcNuno GodinhoContributes to this
In the atlas: contributes to 5@nununoMike PokrakaContributes to this
In the atlas: maintains 1, contributes to 11@pokrakamxinitrc86Contributes to this
In the atlas: maintains 2, contributes to 3@xinitrc867 contributors
Before choosing this
Signals
ActivityQuietNo published releases; repository quiet for 47 months
It publishes no releases, and its repository has been quiet for at least 24 full months. This may be normal for stable software; check whether its current state still fits your use.
What it declares
Every artifact
- Type
- Package
- Origin
- Independently maintained
As a package
- Where it runs
- does not say
- Distributed through
- abapGit
Connections
Handing a service description to clients and tools
Backend exposing ABAP Unit runs and coverage over REST and OData
Download
README
quoted from larshp/ABAP-Swagger under MIT, readABAP-Swagger
An approach to expose ABAP REST services
Usage
1: develop a class in ABAP with public methods
2: implement interface ZIF_SWAG_HANDLER, and register the public methods(example method zif_swag_handler~meta)
3: the methods are now accessible via rest(example)
4: the Swagger UI can be accessed via swagger.html in the base dir of the REST services
Installing and Requirements
Install via abapGit
Requires native JSON support see http://scn.sap.com/community/abap/blog/2013/01/07/abap-and-json or SAP note 1648418
Others providing
Compare all 3 on the OpenAPI page →- abap-openapiabap-openapiGenerates ABAP client classes and ICF server stubs from an OpenAPI v3 document, one self-contained global class and interface per definition, through a web client, a Node.js command line or ABAP itself.independent, abapGenerates ABAP client classes and server stubs from OpenAPI
- ABAP OpenAPI UIABAP OpenAPI UIAn ABAP app that puts a Swagger UI in front of SAP NetWeaver Gateway services, built on Swagger UI and Odata-OpenAPI, installed through abapGit and opened from transaction ZGW_OPENAPI.independent, abapSwagger UI for SAP NetWeaver Gateway services
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
abaplint
Contributors
History in the atlas
- First seen.
For your agent
- Ref
artifact:larshp-abap-swagger- JSON
- /artifacts/larshp-abap-swagger.json
- MCP
- Connecting an agent