Spring Cloud Skipper provides a REST API that lets you access all aspects of the server. The Spring Cloud Skipper shell is a first-class consumer of the API.
Spring Cloud Skipper tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs. The following table shows each verb and how Skipper uses it:
| Verb | Usage |
|---|---|
| Used to retrieve a resource. |
| Used to create a new resource. |
| Used to update an existing resource, including partial updates.
Also used for resources that imply the concept of |
| Used to delete an existing resource. |
Skipper adheres as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes. The following table shows each status and its meaning in Skipper:
| Status code | Usage |
|---|---|
| The request completed successfully. |
| A new resource has been created successfully.
The resource’s URI is available from the response’s |
| An update to an existing resource has been applied successfully. |
| The request was malformed. The response body includes an error that provides further information. |
| The requested resource does not exist. |
Every response has the following header(s):
| Name | Description |
|---|---|
| The |
| Path | Type | Description |
|---|---|---|
|
| The HTTP error that occurred (for example, |
|
| A description of the cause of the error. |
|
| The path to which the request was made. |
|
| The HTTP status code (for example |
|
| The time, in milliseconds, at which the error occurred. |
Spring Cloud Skipper uses hypermedia.
As a result, resources include links to other resources in their responses.
More specifically, responses are in Hypertext Application from resource to resource Language (HAL) format.
Links can be found beneath the _links key.
Consumers of the API should not create URIs themselves.
Instead they should use the links in the resources to navigate.