Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/badgerati/pode.yaml
Extension module for Pode, it allows you to parse and send YAML requests and responses
https://github.com/badgerati/pode.yaml
body-parser extension pode powershell-module requests response yaml yaml-requests
Last synced: 2 days ago
JSON representation
Extension module for Pode, it allows you to parse and send YAML requests and responses
- Host: GitHub
- URL: https://github.com/badgerati/pode.yaml
- Owner: Badgerati
- License: mit
- Created: 2019-12-24T22:41:15.000Z (about 5 years ago)
- Default Branch: develop
- Last Pushed: 2019-12-29T14:45:15.000Z (about 5 years ago)
- Last Synced: 2024-11-15T11:41:58.668Z (2 months ago)
- Topics: body-parser, extension, pode, powershell-module, requests, response, yaml, yaml-requests
- Language: PowerShell
- Size: 6.84 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Pode YAML
[](https://raw.githubusercontent.com/Badgerati/Pode.Yaml/master/LICENSE.txt)
[](https://gitter.im/Badgerati/Pode?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://www.powershellgallery.com/packages/Pode.Yaml)
This is an extension module for the [Pode](https://github.com/Badgerati/Pode) web server (v1.3.0+). It allows you to parse and send YAML requests and responses.
## Install
> Note: this module has a dependency on the [powershell-yaml](https://www.powershellgallery.com/packages/powershell-yaml/0.4.1) module
You can either install this module globally:
```powershell
Install-Module -Name powershell-yaml
Install-Module -Name Pode.Yaml
```
or you can let Pode install it for you locally, by adding the following into your `package.json`:
```json
"modules": {
"powershell-yaml": "latest",
"pode.yaml": "latest"
}
```
## Usage
### Body Parser
You can set this module to be used to parse Request payloads, that have relevant Content-Type. You'll need to first import the module, and then enable it as a body-parser within your server's scriptblock:
```powershell
Import-PodeModule -Name Pode.Yaml -Now
Enable-PodeYamlBodyParser
```
When the parser runs it will either set the event's `Data` object to be:
* A single hashtable - if one YAML document is supplied
* An array of hashtables - if multiple YAML documents are supplied
For example, if a Request comes in with the following payload:
```yaml
---
name: bob
```
Then you can access the `name` in a Route via the event parameters `Data` object:
```powershell
Add-PodeRoute -Method Get -Path '/' -ScriptBlock {
param($e)
$e.Data.name | Out-PodeHost
}
```
Or if the request had multiple documents:
```yaml
---
name: bob
---
name: bill
```
Then the second `name` is accessible as follows:
```powershell
Add-PodeRoute -Method Get -Path '/' -ScriptBlock {
param($e)
$e.Data[0].name | Out-PodeHost
}
```
### Response
You can respond back with YAML in a Route as follows:
```powershell
Add-PodeRoute -Method Get -Path '/' -ScriptBlock {
Write-PodeYamlResponse -Value @{ Name = 'bob' }
}
```
This will write back to the client the follow payload:
```yaml
name: bob
```
### Content Type
The default Content-Type expected on the request, and used on the response is `application/x-yaml`. You can change this by specifying the `-ContentType` parameter on the above `PodeYaml` functions.