1.4.4. OpenAPI Management enabler

1.4.4.1. Introduction

The OpenAPI management enabler will be an API Manager that allows enablers that publish their APIs, to monitor the interfaces lifecycles and also make sure that needs of external third parties (including granted open callers), as well as applications that are using the APIs, are being met.

1.4.4.2. Features

The OpenAPI management enabler has the following features:

  • OpenAPI Publisher: A collection of tools that API providers use to define their APIs. These tools are also responsible to generate API documentation, manage access and usage policies, and can aswell be used for testing-debugging purposes. Candidate technology (and most likely to be used) is Swagger.

  • OpenAPI Portal: A community site that allows the intrested users access to documentation, tutorials, software development kits etc. It can also allow to manage subscription keys and obtain support from the API provider if needed. Candidate technology is WSO2 API Manager + WSO2 Identity Server or Swagger UI.

  • OpenAPI Gateway: A server that acts as an API front-end, which receives API requests and passses them to the backend. Afterwards it returns the responses back to the requester. It can modify the requests and responses on the fly, and it can also provide the functionality to support authentication, authorization, security, audit and caching. Candidate technology is WSO2, Kong, KrakenD.

1.4.4.3. Place in architecture

The OpenAPI Management enabler is part of the horizontal plane enablers, on Application and Services plane.

1.4.4.4. User guide

The user guide will be determined after the release of the enabler.

1.4.4.5. Prerequisites

The software prerequisites are not detailed yet but they briefly are NodeJs, Rest APIs, Apache Ant and Webbrowser.

1.4.4.6. Installation

The installation procedure is under development.

1.4.4.7. Configuration options

The configuration options will be provided after the release of the enabler.

1.4.4.8. Developer guide

The developer guide will be determined after the release of the enabler.

1.4.4.9. Version control and release

Gitlab will be used as version control and release tool.

1.4.4.10. License

Licensing information will be provided after the release of the enabler.

1.4.4.11. Notice(dependencies)

Dependenies list information will be provided after the release of the enabler.