Giter VIP home page Giter VIP logo

abap-openapi's Introduction

ABAP OpenAPI Client & Server Generator

ABAP OpenAPI is an OpenAPI generator tool designed to create API clients, ICF server handlers, and ICF server implementation stubs from OpenAPI documents.

Generate

It is possible to generate the objects using different processes:

  • Generate via our web client
  • Generate via command line (NodeJS)
  • Generate via ABAP

Features

Feature
OpenAPI File Types JSON
OpenAPI Versions v2*, v3
ABAP Versions v702 and up
Object Creation one self-contained global class & interface per OpenAPI definition

* OpenAPI v2 is currently only cabable by converting the v2 file to a v3 file. This can be done manually using the Swagger Editor, or programmatically using Swagger Converter

NOTE: generated code currently uses ZCL_OAPI_JSON, suggest copying the implementation to a local class in the generated global class

Use Cases

API Creator

  • Write the OpenAPI document for your API so that you can generate the ICF handler and Server Implementation boilerplate
  • Use the OpenAPI document to create automatic documentation for your API

API User

  • Use any OpenAPI document to create the client class to consume external APIs

Building/Developing

Prerequisites

NodeJS 16+

Setup

  • clone this repository
  • run npm install

Testing

Unit Tests: npm test Intergration Tests: npm run integration_test

You can try out the generation using Swagger's Petstore Example:

  • Just run npm run petstore
  • The output files will be generated in ./test_v1/generated/

abap-openapi's People

Contributors

larshp avatar colbyhemond avatar gregorwolf avatar cengelvna avatar oberstvongatow avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.