summaryrefslogtreecommitdiffstats
path: root/docs/developer/design/apigateway.rst
blob: dbeb94d0f2c69df89a6a2368bd0e7605b2d469d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0

=================
Parser apigateway
=================

This document provides a description of apigateway, a message relay submodule for the other
parser submodules.

.. contents::
   :depth: 3
   :local:

Overview
--------
Provide unified access interfaces for follow independent parser components:
 - tosca2heat
 - yang2tosca
 - policy2tosca
 - verigraph
 - parser ui
 The apigateway will relay message between above submodules throngh gRPC interface, in additon,
apigateway also exposes restful api to provide parser all functions to the 3rd applications.


Architecture
------------
Apigateway exploits three sub-components:

- **APIGW**, the main part of apigateway, which is the message center.
- **gRPC**, provide gRPC client and server for the other parser sub-modules, it can be devided
into defferent pair of client/server according to the function.
- **CLI**, command line tool for apigateway access and management .

Apigateway architecture is shown below:

.. image:: /images/API_gateway_architecture.png