| 1 | <div align="center">
|
| 2 | <img src="http://files.martianwabbit.com/beau.png?1" height="144"/>
|
| 3 | </div>
|
| 4 |
|
| 5 | <h1 align="center">Beau</h1>
|
| 6 | <p align="center">Testing JSON APIs made easy.</p>
|
| 7 |
|
| 8 | ## What is Beau?
|
| 9 | Beau, is a CLI that executes HTTP requests based on a YAML configuration file. This makes testing easy, it allows you to share test requests with others as part of your repo.
|
| 10 |
|
| 11 | 
|
| 12 |
|
| 13 | ## Installation
|
| 14 | npm install -g beau
|
| 15 |
|
| 16 | ## Usage
|
| 17 | beau [options] -r <Request Alias>
|
| 18 |
|
| 19 | Options:
|
| 20 |
|
| 21 | -h, --help output usage information
|
| 22 | -V, --version output the version number
|
| 23 | -r, --request [request] The alias for the request you'd like to trigger.
|
| 24 | -v, --verbose Show all the information related to the current request and it's response.
|
| 25 | -c, --config [file] Specify your request config file. Defaults to beau.yml in the current directory.
|
| 26 | -l, --list List all requests in the config file.
|
| 27 | -t, --truncate [length] Truncate the content to the given length
|
| 28 |
|
| 29 | ## Example Configuration File
|
| 30 |
|
| 31 | version: 1
|
| 32 | host: https://example.com/api/
|
| 33 |
|
| 34 | POST /session:
|
| 35 | ALIAS: session
|
| 36 | PAYLOAD:
|
| 37 | username: seich
|
| 38 | password: hello01
|
| 39 |
|
| 40 | GET /profile
|
| 41 | ALIAS: profile
|
| 42 | HEADERS:
|
| 43 | authorization: Bearer $session.response.body.token
|
| 44 |
|
| 45 | GET /user/$profile.response.body.id/posts
|
| 46 | ALIAS: friends
|
| 47 | HEADERS:
|
| 48 | authorization: Bearer $session.response.body.token
|
| 49 | PARAMS:
|
| 50 | archived: true
|
| 51 |
|
| 52 | ## Example Usage
|
| 53 | beau -r profile
|
| 54 |
|
| 55 | That would execute the profile request along with it´s dependencies. In this case, the session request would be made as well since we are using it´s response value as part of our current request.
|
| 56 |
|
| 57 | ## License
|
| 58 | Copyright 2017 David Sergio Díaz
|
| 59 |
|
| 60 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
| 61 |
|
| 62 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
| 63 |
|
| 64 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|