mirror of
https://github.com/morten-olsen/http.md.git
synced 2026-02-08 00:46:28 +01:00
docs: improved docs
This commit is contained in:
@@ -209,34 +209,18 @@ The requests from the embedded document are processed, and their `request` and `
|
||||
|
||||
Assume `_shared_requests.md` contains:
|
||||
|
||||
````markdown
|
||||
```http id=sharedGetRequest
|
||||
GET https://httpbin.org/get
|
||||
```
|
||||
````
|
||||
::raw-md[./examples/_shared_requests.md]
|
||||
|
||||
Then, in `main.md`:
|
||||
|
||||
````markdown
|
||||
# Main Document
|
||||
::raw-md[./examples/with-shared-requests.md]
|
||||
|
||||
Let's include some shared requests:
|
||||
<details>
|
||||
<summary>Output</summary>
|
||||
|
||||
::md[./_shared_requests.md]
|
||||
::raw-md[./examples/with-shared-requests.md]{render}
|
||||
|
||||
The shared GET request returned: {{responses.sharedGetRequest.status}}
|
||||
|
||||
Now, a request specific to this document:
|
||||
|
||||
```http
|
||||
POST https://httpbin.org/post
|
||||
Content-Type: application/json
|
||||
|
||||
{"dataFromMain": "someValue", "sharedUrl": "{{requests.sharedGetRequest.url}}"}
|
||||
```
|
||||
|
||||
::response
|
||||
````
|
||||
</details>
|
||||
|
||||
When `main.md` is processed, `_shared_requests.md` will be embedded, its `sharedGetRequest` will be executed, and its data will be available for templating.
|
||||
|
||||
|
||||
3
docs/examples/_shared_requests.md
Normal file
3
docs/examples/_shared_requests.md
Normal file
@@ -0,0 +1,3 @@
|
||||
```http #sharedGetRequest
|
||||
GET https://httpbin.org/get
|
||||
```
|
||||
18
docs/examples/with-shared-requests.md
Normal file
18
docs/examples/with-shared-requests.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Main Document
|
||||
|
||||
Let's include some shared requests:
|
||||
|
||||
::md[./_shared_requests.md]
|
||||
|
||||
The shared GET request returned: {{response.statusText}}
|
||||
|
||||
Now, a request specific to this document:
|
||||
|
||||
```http
|
||||
POST https://httpbin.org/post
|
||||
Content-Type: application/json
|
||||
|
||||
{"dataFromMain": "someValue", "sharedUrl": "{{requests.sharedGetRequest.url}}"}
|
||||
```
|
||||
|
||||
::response
|
||||
@@ -10,6 +10,7 @@ type Response = {
|
||||
statusText: string;
|
||||
headers: Record<string, string>;
|
||||
body?: string;
|
||||
rawBody?: string;
|
||||
};
|
||||
|
||||
type AddRequestOptios = {
|
||||
|
||||
@@ -59,7 +59,8 @@ const httpHandler: ExecutionHandler = ({
|
||||
body
|
||||
});
|
||||
|
||||
let responseText = await response.text();
|
||||
const rawBody = await response.text();
|
||||
let responseText = rawBody;
|
||||
if (options.json) {
|
||||
try {
|
||||
responseText = JSON.parse(responseText);
|
||||
@@ -84,6 +85,7 @@ const httpHandler: ExecutionHandler = ({
|
||||
statusText: response.statusText,
|
||||
headers: Object.fromEntries(response.headers.entries()),
|
||||
body: responseText,
|
||||
rawBody: rawBody,
|
||||
},
|
||||
});
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user