Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #47

Merged
merged 1 commit into from
Apr 5, 2019
Merged

Update docs #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
[![Twitter: @_sa_s](https://img.shields.io/badge/twitter-@_sa_s-blue.svg?style=flat)](https://twitter.com/_sa_s)


Rester is a command line tool to test HTTP APIs. It takes a request description like the following:
Rester is a command line tool to test HTTP APIs. It processes declaratively written request descriptions as a test script, executing and validating the requests as specified.

For instance, a description like the following:

```
# basic.yml
Expand All @@ -17,7 +19,7 @@ requests:
status: 200
```

and processes it
is processed as follows:

[![asciicast](https://asciinema.org/a/237892.svg)](https://asciinema.org/a/237892)

Expand All @@ -33,6 +35,7 @@ Rester currently supports:
- Sending headers
- Using response values as substitution variables
- Batch file processing
- Uploading and downloading of files
- Delay between requests

See [Upcoming Features](https://github.com/finestructure/Rester/issues/28) for a list of what is planned for future releases.
Expand Down Expand Up @@ -72,8 +75,15 @@ Result:

[![asciicast](https://asciinema.org/a/237894.svg)](https://asciinema.org/a/237894)

## More examples

The [examples directory](examples) demonstrates further uses of rester. You can also find the output these examples generate in the [test snapshot directory](Tests/ResterTests/__Snapshots__/ExampleTests/).

A few noteworthy examples for common tasks are

- [`github.yml`](examples/github.yml): Use the Github API to fetch and print the latest release version of `rester`. Demonstrates the use of response variables and how to index into response arrays and objects as well as how to log responses.
- [`multipart.yml`](examples/multipart.yml): Performs a multipart upload of an image.

## Running `rester`

The easiest way to run `rester` is via docker:
Expand Down
4 changes: 0 additions & 4 deletions examples/multipart.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,4 @@ requests:
file: .file(f.png)
validation:
status: 200
json:
method: POST
headers:
Content-Type: multipart/form-data; charset=utf-8; boundary=__X_RESTER_BOUNDARY__
log: json