Syndesis REST API

• Building
• Running
• Deploying
• Endpoints
• Authentication

Swagger

Building

mvn clean install

Start a PostgreSQL DB in a Docker container

docker run -d --rm
-p 5432:5432
-e POSTGRES_USER=postgres
-e POSTGRES_PASSWORD=password
-e POSTGRES_DB=syndesis
postgres

Deploying to Kubernetes

oc login <KUBERNETES_MASTER>
cd runtime
mvn clean package fabric8:build fabric8:deploy fabric8:start

Endpoints

• REST service: http://localhost:8080/api/v1/
• Swagger doc: http://localhost:8080/api/v1/swagger.json

There is a staging URL on OpenShift dedicated that you can test with, along with the Swagger JSON .

This demo endpoint has some preloaded data and can be used for testing and demoing purposes.

Authentication

The REST API is protected via an OAuth 2.0 Bearer Token. The REST API server is a resource server as defined in The OAuth 2.0 Authorization Framework: Bearer Token Usage. This requires all requests include a valid access token in the Authorization header of the request (there are other methods but they are discouraged). The header should look like:

Authorization: Bearer MDQyODExLCJpc3MiOi...

Roland's random notes

• Create image

eval $(minishift docker-env)
cd runtime
mvn fabric8:build -Dfabric8.mode=kubernetes

Ignore warning about not being able to remove old image.

• Kill Pod for syndesis-rest

oc delete pod $(oc get pods | awk '{ print $1 }' | grep syndesis-rest)

• Edit config

oc edit cm syndesis-rest-config

• Get Token from developer-tool in Chrome when having the UI open

TOKEN="...."

• Call the REST API with curl

curl -k -v https://syndesis.192.168.64.3.xip.io/api/v1/integrations -H "Authorization: Bearer $TOKEN" -H "Accept: application/json" -H "Content-Type: application/json" -d '{ "name": "syndesis-test-repo" }'

• Port forward for remote debugging (set JAVA_OPTIONS in your DC to enable it)

oc port-forward $(oc get pods | awk '{ print $1 }' | grep syndesis-rest) 8000:8000