morten/http.md
1
0
Fork 0
mirror of https://github.com/morten-olsen/http.md.git synced 2026-02-08 00:46:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: load env vars

Browse Source
This commit is contained in:
Morten Olsen
2025-05-18 20:34:51 +02:00
parent 0eff8cf603
commit d7b6a3880e
4 changed files with 97 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

143
README.md
View File

@@ -2,24 +2,24 @@
**`http.md` is a powerful tool that transforms your markdown files into living, executable API documentation and testing suites. Write your HTTP requests directly within markdown, see their responses, and use templating to build dynamic examples and test flows.** **`http.md` is a powerful tool that transforms your markdown files into living, executable API documentation and testing suites. Write your HTTP requests directly within markdown, see their responses, and use templating to build dynamic examples and test flows.**
It allows developers to create API documentation that is always accurate and up-to-date because the documentation itself *is* the set of executable requests. This ensures that your examples work and your tests run directly from the documents you share. It allows developers to create API documentation that is always accurate and up-to-date because the documentation itself _is_ the set of executable requests. This ensures that your examples work and your tests run directly from the documents you share.
## Key Features ## Key Features
* **Markdown-Native:** Define HTTP requests using familiar markdown code blocks. - **Markdown-Native:** Define HTTP requests using familiar markdown code blocks.
* **Live Requests:** Execute requests and embed their responses directly into your documentation. - **Live Requests:** Execute requests and embed their responses directly into your documentation.
* **Templating:** Use Handlebars syntax to chain requests, extract data from responses, and use external inputs. - **Templating:** Use Handlebars syntax to chain requests, extract data from responses, and use external inputs.
* **File Embedding:** Include and reuse requests from other markdown files. - **File Embedding:** Include and reuse requests from other markdown files.
* **Terminal & File Output:** View live previews in your terminal or build static markdown files for sharing or static site generation. - **Terminal & File Output:** View live previews in your terminal or build static markdown files for sharing or static site generation.
* **Watch Mode:** Automatically re-render documents on file changes for a fast development loop. - **Watch Mode:** Automatically re-render documents on file changes for a fast development loop.
* **Flexible Configuration:** Control request execution, output formatting, and visibility. - **Flexible Configuration:** Control request execution, output formatting, and visibility.
## Use Cases ## Use Cases
* **API Documentation:** Create clear, executable examples that users can trust. - **API Documentation:** Create clear, executable examples that users can trust.
* **Integration Testing:** Write simple integration test suites that verify API behavior. - **Integration Testing:** Write simple integration test suites that verify API behavior.
* **Tutorials & Guides:** Build step-by-step guides where each HTTP interaction is shown with its real output. - **Tutorials & Guides:** Build step-by-step guides where each HTTP interaction is shown with its real output.
* **Rapid Prototyping:** Quickly experiment with APIs and document your findings. - **Rapid Prototyping:** Quickly experiment with APIs and document your findings.
## Installation ## Installation
@@ -52,7 +52,6 @@ Content-Type: application/json
And here is the response: And here is the response:
::response ::response
```` ````
### Rendering Documents ### Rendering Documents
@@ -134,15 +133,13 @@ server: gunicorn/19.9.0
"json": { "json": {
"greeting": "Hello, http.md!" "greeting": "Hello, http.md!"
}, },
"origin": "185.181.220.204",
"url": "https://httpbin.org/post" "url": "https://httpbin.org/post"
} }
``` ```
```` ````
*(Note: Actual headers and some response fields might vary.)* _(Note: Actual headers and some response fields might vary.)_
## Core Concepts ## Core Concepts
@@ -183,8 +180,8 @@ All requests in a document are executed sequentially from top to bottom by defau
The `::response` directive is used to render the full HTTP response (status line, headers, and body) of an HTTP request. The `::response` directive is used to render the full HTTP response (status line, headers, and body) of an HTTP request.
* **Implicit Last:** If used without any arguments (i.e., `::response`), it renders the response of the most recently defined `http` block above it. - **Implicit Last:** If used without any arguments (i.e., `::response`), it renders the response of the most recently defined `http` block above it.
* **Explicit by ID:** You can render the response of a specific request by referencing its ID (see [Request IDs](https://www.google.com/search?q=%23request-ids)). - **Explicit by ID:** You can render the response of a specific request by referencing its ID (see [Request IDs](https://www.google.com/search?q=%23request-ids)).
### Request IDs ### Request IDs
@@ -218,7 +215,6 @@ Response from creating the user:
Response from getting the item: Response from getting the item:
::response{#getItem} ::response{#getItem}
```` ````
## Templating with Handlebars ## Templating with Handlebars
@@ -231,33 +227,33 @@ Templating syntax uses double curly braces: `{{expression}}`.
Within your markdown document, the following variables are available in the Handlebars context: Within your markdown document, the following variables are available in the Handlebars context:
* **`request`** (Object): Details of the most recently processed HTTP request *before* it's sent. - **`request`** (Object): Details of the most recently processed HTTP request _before_ it's sent.
* `request.method` (String): The HTTP method (e.g., "GET", "POST"). - `request.method` (String): The HTTP method (e.g., "GET", "POST").
* `request.url` (String): The request URL. - `request.url` (String): The request URL.
* `request.headers` (Object): An object containing request headers. - `request.headers` (Object): An object containing request headers.
* `request.body` (String): The raw request body. - `request.body` (String): The raw request body.
* **`response`** (Object): Details of the most recently received HTTP response. - **`response`** (Object): Details of the most recently received HTTP response.
* `response.status` (Number): The HTTP status code (e.g., 200, 404). - `response.status` (Number): The HTTP status code (e.g., 200, 404).
* `response.statusText` (String): The HTTP status message (e.g., "OK", "Not Found"). - `response.statusText` (String): The HTTP status message (e.g., "OK", "Not Found").
* `response.headers` (Object): An object containing response headers. - `response.headers` (Object): An object containing response headers.
* `response.body` (String/Object): The response body. If the `http` block had the `json` option and the response was valid JSON, this will be a parsed JSON object. Otherwise, it's a raw string. - `response.body` (String/Object): The response body. If the `http` block had the `json` option and the response was valid JSON, this will be a parsed JSON object. Otherwise, it's a raw string.
* `response.rawBody` (String): The raw response body as a string, regardless of parsing. - `response.rawBody` (String): The raw response body as a string, regardless of parsing.
* *(In case of network errors or non-HTTP errors, `status` and `body` might reflect error information.)* - _(In case of network errors or non-HTTP errors, `status` and `body` might reflect error information.)_
* **`requests`** (Object): A dictionary mapping request IDs to their respective `request` objects (as defined above). - **`requests`** (Object): A dictionary mapping request IDs to their respective `request` objects (as defined above).
* Example: `{{requests.createUser.url}}` - Example: `{{requests.createUser.url}}`
* **`responses`** (Object): A dictionary mapping request IDs to their respective `response` objects (as defined above). - **`responses`** (Object): A dictionary mapping request IDs to their respective `response` objects (as defined above).
* Example: `{{responses.createUser.status}}`, `{{responses.createUser.body.id}}` (if `body` is a parsed JSON object). - Example: `{{responses.createUser.status}}`, `{{responses.createUser.body.id}}` (if `body` is a parsed JSON object).
* **`input`** (Object): A dictionary of variables passed to `http.md` via the command line using the `-i` or `--input` flag. - **`input`** (Object): A dictionary of variables passed to `http.md` via the command line using the `-i` or `--input` flag.
* Example: If you run `httpmd dev -i userId=123 -i apiKey=secret myfile.md`, you can use `{{input.userId}}` and `{{input.apiKey}}`. - Example: If you run `httpmd dev -i userId=123 -i apiKey=secret myfile.md`, you can use `{{input.userId}}` and `{{input.apiKey}}`.
### Templating Examples ### Templating Examples
@@ -280,10 +276,9 @@ GET https://httpbin.org/anything/{{responses.createItem.body.json.name}}
``` ```
::response{#fetchItem} ::response{#fetchItem}
```` ````
*(Note: `httpbin.org/post` wraps the JSON sent in a "json" field in its response. If your API returns the ID directly at the root of the JSON body, you'd use `{{responses.createItem.body.id}}` assuming the `createItem` request had the `json` option.)* _(Note: `httpbin.org/post` wraps the JSON sent in a "json" field in its response. If your API returns the ID directly at the root of the JSON body, you'd use `{{responses.createItem.body.id}}` assuming the `createItem` request had the `json` option.)_
**2. Displaying a status code in markdown text:** **2. Displaying a status code in markdown text:**
@@ -292,7 +287,7 @@ GET https://httpbin.org/anything/{{responses.createItem.body.json.name}}
GET https://httpbin.org/status/201 GET https://httpbin.org/status/201
``` ```
The request to `/status/201` completed with status code: ****. The request to `/status/201` completed with status code: \*\*\*\*.
```` ````
## Managing Documents ## Managing Documents
@@ -369,17 +364,17 @@ Authorization: Bearer
You can configure the behavior of each `http` code block by adding options to its info string, separated by commas. You can configure the behavior of each `http` code block by adding options to its info string, separated by commas.
* `id={your-id}`: Assigns a unique ID to the request. This ID can be used to reference the request's response in the `::response` directive and in templating variables (`requests.your-id`, `responses.your-id`). - `id={your-id}`: Assigns a unique ID to the request. This ID can be used to reference the request's response in the `::response` directive and in templating variables (`requests.your-id`, `responses.your-id`).
* Example: ` ```http id=getUser,json ` - Example: ` ```http id=getUser,json `
* `json`: If present, `http.md` will attempt to parse the **response body** as JSON. If successful, `response.body` (and `responses.id.body`) will be the parsed JavaScript object/array, making it easier to access its properties in templates (e.g., `{{response.body.fieldName}}`). - `json`: If present, `http.md` will attempt to parse the **response body** as JSON. If successful, `response.body` (and `responses.id.body`) will be the parsed JavaScript object/array, making it easier to access its properties in templates (e.g., `{{response.body.fieldName}}`).
* Example: ` ```http json ` - Example: ` ```http json `
* `yaml`: If present, the **request body** written in YAML format within the code block will be automatically converted to JSON before the request is sent. This allows for writing complex request bodies in a more human-readable YAML syntax. You should still set the `Content-Type` header appropriately (e.g., to `application/json`) if the server expects JSON. - `yaml`: If present, the **request body** written in YAML format within the code block will be automatically converted to JSON before the request is sent. This allows for writing complex request bodies in a more human-readable YAML syntax. You should still set the `Content-Type` header appropriately (e.g., to `application/json`) if the server expects JSON.
* Example: - Example:
````markdown ````markdown
```http yaml ```http yaml
@@ -394,13 +389,13 @@ You can configure the behavior of each `http` code block by adding options to it
``` ```
```` ````
* `disable`: If present, the HTTP request will **not** be executed. No actual network call will be made. The corresponding `response` variable will be undefined or empty, and `::response` will typically render a "Request disabled" message or similar. - `disable`: If present, the HTTP request will **not** be executed. No actual network call will be made. The corresponding `response` variable will be undefined or empty, and `::response` will typically render a "Request disabled" message or similar.
* Example: ` ```http disable ` - Example: ` ```http disable `
* `hidden`: If present, the `http` code block itself will **not be included** in the rendered output document. However, the request *is still made* (unless `disable` is also specified), and its response data can be used in templates or displayed with an explicit `::response{#id}` directive. This is useful for prerequisite requests (like authentication) whose details you don't want to clutter the main documentation. - `hidden`: If present, the `http` code block itself will **not be included** in the rendered output document. However, the request _is still made_ (unless `disable` is also specified), and its response data can be used in templates or displayed with an explicit `::response{#id}` directive. This is useful for prerequisite requests (like authentication) whose details you don't want to clutter the main documentation.
* Example: ` ```http id=authRequest,hidden ` - Example: ` ```http id=authRequest,hidden `
**Combined Example:** **Combined Example:**
@@ -426,12 +421,12 @@ Directives can also have options, specified similarly.
#### `::response` Directive Options #### `::response` Directive Options
* `id={id}` (or `#{id}` as a shorthand): Renders the output of a specific request identified by `{id}`. - `id={id}` (or `#{id}` as a shorthand): Renders the output of a specific request identified by `{id}`.
* Example: `::response{#getUser}` or `::response{id=getUser}` - Example: `::response{#getUser}` or `::response{id=getUser}`
* `yaml`: Renders the (typically JSON) response body formatted as YAML. This is for display purposes. - `yaml`: Renders the (typically JSON) response body formatted as YAML. This is for display purposes.
* Example: `::response{yaml}` - Example: `::response{yaml}`
* `truncate={chars}`: Truncates the displayed **response body** to the specified number of characters. Headers and status line are not affected. - `truncate={chars}`: Truncates the displayed **response body** to the specified number of characters. Headers and status line are not affected.
* Example: `::response{truncate=100}` - Example: `::response{truncate=100}`
**Combined Example for `::response`:** **Combined Example for `::response`:**
`::response{#getUser,yaml,truncate=500}` - Displays the response for request `getUser`, formats its body as YAML, and truncates the body display to 500 characters. `::response{#getUser,yaml,truncate=500}` - Displays the response for request `getUser`, formats its body as YAML, and truncates the body display to 500 characters.
@@ -440,21 +435,21 @@ Directives can also have options, specified similarly.
The `::md` directive embeds another markdown document. The `::md` directive embeds another markdown document.
* **File Path:** The first argument (required) is the path to the markdown file to embed. - **File Path:** The first argument (required) is the path to the markdown file to embed.
* Example: `::md[./includes/authentication.md]` - Example: `::md[./includes/authentication.md]`
* `hidden`: If present, the actual content (markdown) of the embedded document will not be rendered in the output. However, any `http` requests within the embedded document *are still processed*, and their `request` and `response` data become available in the parent document's templating context (via `requests.id` and `responses.id`). This is useful if you only want to execute the requests from an included file (e.g., a common setup sequence) and use their results, without displaying the embedded file's content. - `hidden`: If present, the actual content (markdown) of the embedded document will not be rendered in the output. However, any `http` requests within the embedded document _are still processed_, and their `request` and `response` data become available in the parent document's templating context (via `requests.id` and `responses.id`). This is useful if you only want to execute the requests from an included file (e.g., a common setup sequence) and use their results, without displaying the embedded file's content.
* Example: `::md[./setup_requests.md]{hidden}` - Example: `::md[./setup_requests.md]{hidden}`
#### `::input[{name}]` Directive Options #### `::input[{name}]` Directive Options
The `::input` directive is used to declare expected input variables The `::input` directive is used to declare expected input variables
* **Variable Name:** The first argument (required) is the name of the variable - **Variable Name:** The first argument (required) is the name of the variable
* Example: `::input[myVariable]` will define `input.myVariable` - Example: `::input[myVariable]` will define `input.myVariable`
* `required`: If present it will require that the variable is provided - `required`: If present it will require that the variable is provided
* `default={value}`: Defines the default value if no value has been provided - `default={value}`: Defines the default value if no value has been provided
* `format=string|number|bool|json|date`: If provided the value will be parsed using the specified format - `format=string|number|bool|json|date`: If provided the value will be parsed using the specified format
* \`\` - \`\`
## Command-Line Interface (CLI) ## Command-Line Interface (CLI)
@@ -464,10 +459,10 @@ The `httpmd` tool provides the following commands:
Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and prints the resulting markdown to the **terminal (stdout)**. Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and prints the resulting markdown to the **terminal (stdout)**.
* **Purpose:** Useful for live development and quick previews. - **Purpose:** Useful for live development and quick previews.
* **Options:** - **Options:**
* `--watch`: Monitors the `<source_file.md>` (and any embedded files) for changes. On detection of a change, it automatically re-processes and re-renders the output to the terminal. - `--watch`: Monitors the `<source_file.md>` (and any embedded files) for changes. On detection of a change, it automatically re-processes and re-renders the output to the terminal.
* `-i <key=value>`, `--input <key=value>`: Defines an input variable for templating (see [Using Input Variables](https://www.google.com/search?q=%23using-input-variables)). Can be specified multiple times for multiple variables. - `-i <key=value>`, `--input <key=value>`: Defines an input variable for templating (see [Using Input Variables](https://www.google.com/search?q=%23using-input-variables)). Can be specified multiple times for multiple variables.
**Example:** **Example:**
@@ -479,10 +474,10 @@ httpmd dev api_tests.md --watch -i host=localhost:3000
Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and saves the resulting markdown to `<output_file.md>`. Processes the `<source_file.md>`, executes all HTTP requests, resolves templates, and saves the resulting markdown to `<output_file.md>`.
* **Purpose:** Generates a static, shareable markdown file with all dynamic content resolved. Ideal for version control, static site generation, or distributing documentation. - **Purpose:** Generates a static, shareable markdown file with all dynamic content resolved. Ideal for version control, static site generation, or distributing documentation.
* **Options:** - **Options:**
* `--watch`: Monitors the `<source_file.md>` (and any embedded files) for changes. On detection of a change, it automatically re-processes and re-builds the `<output_file.md>`. - `--watch`: Monitors the `<source_file.md>` (and any embedded files) for changes. On detection of a change, it automatically re-processes and re-builds the `<output_file.md>`.
* `-i <key=value>`, `--input <key=value>`: Defines an input variable for templating. - `-i <key=value>`, `--input <key=value>`: Defines an input variable for templating.
**Example:** **Example:**

1
bin/cli.mjs
View File

@@ -1,3 +1,4 @@
#!/usr/bin/env node #!/usr/bin/env node
import 'dotenv/config.js';
import '../dist/cli/cli.js'; import '../dist/cli/cli.js';

1
package.json
View File

@@ -36,6 +36,7 @@
"dependencies": { "dependencies": {
"blessed": "^0.1.81", "blessed": "^0.1.81",
"commander": "^14.0.0", "commander": "^14.0.0",
"dotenv": "^16.5.0",
"eventemitter3": "^5.0.1", "eventemitter3": "^5.0.1",
"handlebars": "^4.7.8", "handlebars": "^4.7.8",
"hastscript": "^9.0.1", "hastscript": "^9.0.1",

9
pnpm-lock.yaml generated
View File

@@ -14,6 +14,9 @@ importers:
commander: commander:
specifier: ^14.0.0 specifier: ^14.0.0
version: 14.0.0 version: 14.0.0
dotenv:
specifier: ^16.5.0
version: 16.5.0
eventemitter3: eventemitter3:
specifier: ^5.0.1 specifier: ^5.0.1
version: 5.0.1 version: 5.0.1
@@ -657,6 +660,10 @@ packages:
devlop@1.1.0: devlop@1.1.0:
resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==} resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==}
dotenv@16.5.0:
resolution: {integrity: sha512-m/C+AwOAr9/W1UOIZUo232ejMNnJAJtYQjUbHoNTBNTJSvqzzDh7vnrei3o3r3m9blf6ZoDkvcw0VmozNRFJxg==}
engines: {node: '>=12'}
emoji-regex@8.0.0: emoji-regex@8.0.0:
resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==} resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==}
@@ -2077,6 +2084,8 @@ snapshots:
dependencies: dependencies:
dequal: 2.0.3 dequal: 2.0.3
dotenv@16.5.0: {}
emoji-regex@8.0.0: {} emoji-regex@8.0.0: {}
emojilib@2.4.0: {} emojilib@2.4.0: {}