docs/developer/design/apigateway.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 =================
   5 Parser apigateway
   6 =================
   7
   8 This document provides a description of apigateway, a message relay submodule for the other
   9 parser submodules.
  10
  11 .. contents::
  12    :depth: 3
  13    :local:
  14
  15 Overview
  16 --------
  17 Provide unified access interfaces for follow independent parser components:
  18  - tosca2heat
  19  - yang2tosca
  20  - policy2tosca
  21  - verigraph
  22  - parser ui
  23  The apigateway will relay message between above submodules throngh gRPC interface, in additon,
  24 apigateway also exposes restful api to provide parser all functions to the 3rd applications.
  25
  26
  27 Architecture
  28 ------------
  29 Apigateway exploits three sub-components:
  30
  31 - **APIGW**, the main part of apigateway, which is the message center.
  32 - **gRPC**, provide gRPC client and server for the other parser sub-modules, it can be devided
  33 into defferent pair of client/server according to the function.
  34 - **CLI**, command line tool for apigateway access and management .
  35
  36 Apigateway architecture is shown below:
  37
  38 .. image:: /images/API_gateway_architecture.png