Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openclassrooms/apitester
Auto test your api using your api definition
https://github.com/openclassrooms/apitester
api automation testing
Last synced: 3 days ago
JSON representation
Auto test your api using your api definition
- Host: GitHub
- URL: https://github.com/openclassrooms/apitester
- Owner: OpenClassrooms
- License: mit
- Created: 2021-02-11T09:12:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T16:41:15.000Z (11 days ago)
- Last Synced: 2024-11-06T17:31:10.546Z (11 days ago)
- Topics: api, automation, testing
- Language: PHP
- Homepage:
- Size: 1.01 MB
- Stars: 5
- Watchers: 8
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# API Tester
This project is aimed to improve the testing experience by providing
automatic tests based on your OpenAPI specification. It is based on PHPUnit so it support all of it's feature, like coverage for example.
It also provides special support for symonfy kernel, providing a mode where it uses directly the kernel to send requests instead of an http client, which is useful for transactions support for example.
## Installation
Require it locally to use on your current project
`composer require openclassrooms/api-tester`
Or require it globally
`composer require -g openclassrooms/api-tester`
## Usage
### Minimum configuration
To run tests you must create `api-tester.yaml` file at the root of your project and add this minimum configuration in the created file.
```yaml
# ./api-tester.yaml
suites:
- name: 'all' #you can use any name you want to identify your suites
definition:
path: 'openapi.yml' #any path to get your OpenAPI specifications file
format: 'openapi'
requester: 'http-async'
```
In addition and if your api uses authentication to allow access to endpoints, you should also provide auth method like this example
```yaml
# ./api-tester.yaml
auth:
- name: 'admin'
body:
username: '[email protected]'
password: 'password'
headers:
Accept: 'application/json'
Content-Type: 'application/json'
```
So your minimal configuration file would looks like
```yaml
# ./api-tester.yaml
suites:
- name: 'all'
definition:
path: 'openapi.yml'
format: 'openapi'
requester: 'http-async'
auth:
- name: 'admin'
body:
username: '[email protected]'
password: 'password'
headers:
Accept: 'application/json'
Content-Type: 'application/json'
```
Then you can add more configuration to suite your needs. See complete [configuration reference](./docs/configuration_reference.md) to learn more.
### Run tests
`./vendor/bin/api-tester`
#### Command options
```bash
-c, --config[=CONFIG] config file [default: "api-tester.yaml"]
-s, --suite[=SUITE] suite name to run
--testdox testdox print format
--coverage-php[=COVERAGE-PHP] coverage export to php format
--coverage-clover[=COVERAGE-CLOVER] coverage export to clover format
--coverage-html[=COVERAGE-HTML] coverage export to html format
--coverage-text[=COVERAGE-TEXT] coverage export to html format
--coverage-cobertura[=COVERAGE-COBERTURA] coverage export to html format
--set-baseline if set it will create a baseline file that will register all errors so they become ignored on the next run
--update-baseline update baseline with new errors to ignore
--ignore-baseline ignore baseline file
--filter[=FILTER] Filter which tests to run
--log-junit[=LOG-JUNIT] Log test execution in JUnit XML format to file
--log-teamcity[=LOG-TEAMCITY] Log test execution in JUnit XML format to file
--testdox-html[=TESTDOX-HTML] Write agile documentation in HTML format to file
--testdox-text[=TESTDOX-TEXT] Write agile documentation in Text format to file
--testdox-xml[=TESTDOX-XML] Write agile documentation in XML format to file
--part[=PART] Partition tests into groups and run only one of them, ex: --part=1/3
-h, --help Display help for the given command. When no command is given display help for the launch command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```