Updated Admin API Reference (markdown)

Stef Heyenrath
2017-02-10 20:34:55 +01:00
parent b21ddff1a3
commit 22fceac337
+15 -16
@@ -7,7 +7,7 @@ var server = FluentMockServer.StartWithAdminInterface();
``` ```
The following interfaces are supported: The following interfaces are supported:
### /__admin/mappings ## /__admin/mappings
The mappings defined in the mock service. The mappings defined in the mock service.
* `GET /__admin/mappings` --> Gets all defined mappings * `GET /__admin/mappings` --> Gets all defined mappings
* `POST /__admin/mappings` --> Create a new stub mapping * `POST /__admin/mappings` --> Create a new stub mapping
@@ -16,7 +16,7 @@ The mappings defined in the mock service.
* `PUT /__admin/mappings/{guid}` --> Update a stub mapping * `PUT /__admin/mappings/{guid}` --> Update a stub mapping
* `DELETE /__admin/mappings/{guid}` --> Delete a single stub mapping * `DELETE /__admin/mappings/{guid}` --> Delete a single stub mapping
### /__admin/requests ## /__admin/requests
Logged requests and responses received by the mock service. Logged requests and responses received by the mock service.
* `GET /__admin/requests` --> Get received requests * `GET /__admin/requests` --> Get received requests
* `DELETE /__admin/requests` --> Delete all received requests * `DELETE /__admin/requests` --> Delete all received requests
@@ -27,7 +27,6 @@ Logged requests and responses received by the mock service.
* `GET /__admin/requests/unmatched` --> TODO * `GET /__admin/requests/unmatched` --> TODO
* `GET /__admin/requests/unmatched/near-misses` --> TODO * `GET /__admin/requests/unmatched/near-misses` --> TODO
*** ***
For some **example requests**, see this [PostMan Collection](https://www.getpostman.com/collections/b69dcea7ec19473bff1e) For some **example requests**, see this [PostMan Collection](https://www.getpostman.com/collections/b69dcea7ec19473bff1e)
*** ***
@@ -124,7 +123,7 @@ Example response:
] ]
``` ```
## `POST /__admin/mappings` ### `POST /__admin/mappings`
Create a new stub mapping Create a new stub mapping
Example request: Example request:
@@ -172,13 +171,13 @@ Example request:
} }
``` ```
## `DELETE /__admin/mappings` ### `DELETE /__admin/mappings`
Delete all stub mappings. Delete all stub mappings.
## `GET /__admin/mappings/{guid}` ### `GET /__admin/mappings/{guid}`
Get a single stub mapping Get a single stub mapping
## `PUT /__admin/mappings/{guid}` ### `PUT /__admin/mappings/{guid}`
Update a single stub mapping Update a single stub mapping
Example request Example request
@@ -213,25 +212,25 @@ Example request
} }
``` ```
## `DELETE /__admin/mappings/{guid}` ### `DELETE /__admin/mappings/{guid}`
Delete a single stub mapping. Delete a single stub mapping.
## /__admin/requests ## /__admin/requests
Logged requests and responses received by the mock service. Logged requests and responses received by the mock service.
## `GET /__admin/requests` ### `GET /__admin/requests`
Get received requests Get received requests
## `DELETE /__admin/requests` ### `DELETE /__admin/requests`
Delete all received requests Delete all received requests
## `GET /__admin/requests/{guid}` ### `GET /__admin/requests/{guid}`
Get a single request. Get a single request.
### `POST /__admin/requests/reset` --> TODO #### `POST /__admin/requests/reset` --> TODO
### `POST /__admin/requests/count` --> TODO #### `POST /__admin/requests/count` --> TODO
### `POST /__admin/requests/find` --> TODO #### `POST /__admin/requests/find` --> TODO
### `GET /__admin/requests/unmatched` --> TODO #### `GET /__admin/requests/unmatched` --> TODO
### `GET /__admin/requests/unmatched/near-misses` --> TODO #### `GET /__admin/requests/unmatched/near-misses` --> TODO