HTTP API Gateway Specification Reference
Bondy HTTP API Gateway acts as a reverse proxy by accepting incoming REST API actions and translating them into WAMP actions over a Realm's procedures and topics.
Loading an API Gateway Specification
Learn how to load an API Gateway Specification using the HTTP Admin API.
Loading an API you have defined using the API Gateway Specification is very easy you just need to know the location of your file and use the HTTP Admin API.
Assumptions
The following instructions assume the following:
- Your API Specification file is called
my_api.json - Your API Specification
idproperty has the valuecom.example.my_api - Bondy is running at
localhoston port18081
Host and Port
The above assumption means the bondy.conf file which you use to start Bondy contains the following configuration options:
admin_api.http.enabled = onadmin_api.http.port = 18081
Loading the API Specification
The following command will load the API Specification, validate it and if successful it will be compiled and activate it.
bash
curl -X "POST" "http://localhost:18081/services/load_api_spec" \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Accept: application/json; charset=utf-8' \
--data-binary "@my_api.json"
Cluster deployments
If this node is part of a Bondy cluster, the API will be automatically replicated and activated in all nodes.
Verifying the API Specification has been loaded
If the previous command didn't fail the API has been loaded and activated. However, to be entirely sure you can use the following command which should retrieve the API Specification.
bash
curl -X "GET" "http://localhost:18081/api_specs/com.example.my_api"