Weave REST API

Weave REST API provides an HTTP API to access services provided by Weave.  All services exposed by the REST API are accessible through a hierarchy of web resources. 

URL structure of REST resources

REST API URL's conform to the following pattern:

http://<hostname>:<port>/weave/services/<version>/<resource>

Example:

http://myhost.mydomain.org:8080/weave/services/v1/map

Swagger Integration

Swagger Definition

When Weave is deployed with the relevant Swagger bundles, a swagger definition of the REST API can be obtained via the URI:

http://<hostname>:<port>/weave/services/swagger.json

Swagger UI

When the relevant bundles are active, an in-built Swagger UI is available via the URI:

http://<hostname>:<port>/weave/swagger/index.html

Authentication

Weave supports authentication and authorisation via Spring security. By default, the current implementation of the API functions with all users authenticated as 'anonymous'.

By integrating a third party authentication service, along with an appropriate Spring security plugin, Weave REST API can be configured to utilise the same authentication. 

Resources

The API is grouped into the following resource categories: