A modern HTTP Client.
Go to file
Sergio Díaz fea72dde2a
Allow urls as endpoints (#55)
* Added support for multiple request configurations.

This allows multiple requests to hit the same verb+path combination.
This was previously impossible, to address it, it's now possible to pass
an array of request settings as the body of a request each request will
be added to the request list individually.

Example:
```
GET /some/path:
  - alias: first
    headers:
      request: first
  - alias: second
    headers:
      request: second
```

* Allows using full urls in the request key

This allows you to break out of the top-level endpoint. If you send a
full url instead of a path it'll be used instead of the top level
endpoint.

Example:
```
endpoint: http://example.com
GET /posts: get-posts
POST http://api.example.com/posts: post-post
```
2019-03-11 22:04:20 -06:00
bin This allows extra documents in a yaml config file to be embeded as hosts.(#40) 2018-07-31 23:23:32 -06:00
examples This allows extra documents in a yaml config file to be embeded as hosts.(#40) 2018-07-31 23:23:32 -06:00
media Updated Readme. (#43) 2018-08-01 11:14:20 -06:00
src Allow urls as endpoints (#55) 2019-03-11 22:04:20 -06:00
.gitattributes Added beau-std as a direct dependency of Beau. 2018-06-19 11:29:41 -06:00
.gitignore Added swp to gitignore. 2018-05-07 17:18:03 +00:00
.prettierrc Reindenting. (#17) 2018-05-04 11:47:28 -06:00
LICENSE Added support for multiple hosts. 2018-01-19 18:10:00 -06:00
README.md Updated Readme. (#43) 2018-08-01 11:14:20 -06:00
circle.yml Added a new top-level setting: defaults. 2017-12-27 16:43:47 -06:00
package-lock.json Added support for multiple request configurations. (#54) 2019-03-11 21:14:34 -06:00
package.json Update strip-ansi to the latest version 🚀 (#53) 2019-03-11 17:35:31 -06:00

README.md

Beau's Logo is a Seahorse

Beau

Testing JSON APIs made easy.

CircleCI

What is Beau?

Beau is a modern http client. It uses a YAML file as configuration allowing you to test APIs without having to write lengthy commands.

A gif showing how beau works.

Installation

npm install -g beau

Usage

$ beau [COMMAND]

COMMANDS
  help      display help for beau
  list      Lists all available requests in the config file.
  request   Executes a request by name.
  validate  Validates the given configuration file against Beau's configuration schema.

Example Configuration File

endpoint: https://httpbin.org/

POST /anything:
    alias: anything
    payload:
      hello: world
$ beau request anything

Status              Endpoint
200                 https://httpbin.org/anything

{
...
  json: {
    hello: "world"
  },
  method: "POST",
  url: "https://httpbin.org/anything"
  ...
}

Documentation

Visit https://beaujs.com/docs/ for the complete docs.

License

Copyright 2018 David Sergio Díaz

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.