Getting Started
The Jalapeño API Gateway uses gRPC for communication. This means you simply have to import the compiled Protobuf definitions and initialize a gRPC connection and you are ready to go.
Step 1: Importing the compiled Protobuf definitions#
To address the Gateway you can either compile the Protobuf files yourself or use the languages-specific repositories containing the already compiled code.
Option 1: Using the the pre-compiled files [recommended]#
Option 1.1: Download files from Release Page#
The easiest way to use the Jalapeño API Gateway is to simply download and import the pre-compiled, language-specific Protobuf files from the release page:
Option 1.2: Golang only#
If you are using Golang, you will not find the pre-compiled files in the release page, but rather in a dedicated repository:
This allows you to directly import the go module to your project with:
$ go get github.com/jalapeno-api-gateway/jagw-go@v1.4.0See also Go Packages
Option 1.3: Python only#
If you are using Python, you will not find the pre-compiled files in the release page, but rather in a dedicated repository:
This allows you to directly import the python module to your project with:
$ pip install jagw-pythonOption 2: Compiling the Protobuf files yourself#
If you prefer to compile to Protobuf files yourself or if we do not offer pre-compiled files for your development language you can download the Protobuf files from our jagw repo.
To compile the files, you will need to install both the protobuf compiler and the language specific gRPC compiler.
Step 2: Initialize gRPC connection#
Once you have imported the compiled Protobuf code to your project, you can connect to the Request Service and the Subscription Service and use the gRPC Methods documented in the API Documentation.
To initialize a gRPC connection, refer to the language specific documentation for gRPC (i.e. for Golang).
Default Ports#
The default ports for the two services are shown in the table below.
| Service | Port |
|---|---|
| Request-Service | 9903 |
| Subscription-Service | 9902 |
Sample SR-Apps#
You can also refer to our demo-sr-app to get started.
Examples#
More examples can be found under: