apid-cli

README

APId - CLI

Powerful declarative end-to-end testing for APIs that works for you! No coding required. Simple to run on any continuous integration tool.

Documentation

You can find all APId documentation here.

Instalation

1. Head to the latest release and select the binary for your operating system.
2. Once downloaded open the archive and place the executable in a directory on your $PATH.

First steps

Using APId

apid check --config path/to/apid_config.yml

Generating shell completion

Currently apid can generate shell completion for bash, zsh and powershell

apid completion bash -f /etc/bash.completion.d/apid.sh

Development

All useful development commands can be found in the Makefile. Follow these simple steps to build and test the CLI locally:

1. Install Mockgen

Mockgen is used to generate mock implementations for testing

go get github.com/golang/mock/mockgen

2. Building and running CLI tests

make

3. Running CLI end-to-end tests

make e2e

4. Update the docs

The docs are located in the docs folder. The docs site automatically pulls the latest master version of the docs.

Contributing

To contribute to APId, please see CONTRIBUTING.

For questions and discussion join our FAQ page.