8feda81fcd
- as a bonus only `servant-client` depends on `kan-extensions`
557 lines
7.8 KiB
Markdown
557 lines
7.8 KiB
Markdown
## GET /
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /alternative/left
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /alternative/right
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /capture/:foo
|
|
|
|
### Captures:
|
|
|
|
- *foo*: Capture foo Int
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /capture-all/:foo
|
|
|
|
### Captures:
|
|
|
|
- *foo*: Capture all foo Int
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /description
|
|
|
|
### foo
|
|
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /flag
|
|
|
|
### GET Parameters:
|
|
|
|
- foo
|
|
- **Description**: QueryFlag
|
|
- This parameter is a **flag**. This means no value is expected to be associated to this parameter.
|
|
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /foo
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /get-int
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
17
|
|
```
|
|
|
|
## GET /header
|
|
|
|
### Headers:
|
|
|
|
- This endpoint is sensitive to the value of the **foo** HTTP header.
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /header-lenient
|
|
|
|
### Headers:
|
|
|
|
- This endpoint is sensitive to the value of the **bar** HTTP header.
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /http-version
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /is-secure
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /named-context
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /param
|
|
|
|
### GET Parameters:
|
|
|
|
- foo
|
|
- **Values**: *1, 2, 3*
|
|
- **Description**: QueryParams Int
|
|
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /param-lenient
|
|
|
|
### GET Parameters:
|
|
|
|
- bar
|
|
- **Values**: *1, 2, 3*
|
|
- **Description**: QueryParams Int
|
|
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /params
|
|
|
|
### GET Parameters:
|
|
|
|
- foo
|
|
- **Values**: *1, 2, 3*
|
|
- **Description**: QueryParams Int
|
|
- This parameter is a **list**. All GET parameters with the name foo[] will forward their values in a list to the handler.
|
|
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## POST /post-int
|
|
|
|
### Response:
|
|
|
|
- Status code 204
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
17
|
|
```
|
|
|
|
## POST /post-no-content
|
|
|
|
### Response:
|
|
|
|
- Status code 204
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /raw
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- No response body
|
|
|
|
## GET /remote-host
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /req-body
|
|
|
|
### Request:
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
17
|
|
```
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /req-body-lenient
|
|
|
|
### Request:
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
17
|
|
```
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /res-headers
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: [("foo","17")]
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /streaming
|
|
|
|
### Request:
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- No response body
|
|
|
|
## GET /summary
|
|
|
|
### foo
|
|
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|
|
## GET /vault
|
|
|
|
### Response:
|
|
|
|
- Status code 200
|
|
- Headers: []
|
|
|
|
- Supported content types are:
|
|
|
|
- `application/json;charset=utf-8`
|
|
- `application/json`
|
|
|
|
- Example (`application/json;charset=utf-8`, `application/json`):
|
|
|
|
```javascript
|
|
|
|
```
|
|
|