https://github.com/yuryalencar/rest_api_test_automation_template
This is a template for make API tests using the Robot Framework creating a tests suite.
https://github.com/yuryalencar/rest_api_test_automation_template
api-rest api-tests python3 robotframework template-project tests
Last synced: 8 months ago
JSON representation
This is a template for make API tests using the Robot Framework creating a tests suite.
- Host: GitHub
- URL: https://github.com/yuryalencar/rest_api_test_automation_template
- Owner: yuryalencar
- License: mit
- Created: 2020-09-22T14:12:31.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-03T14:12:57.000Z (almost 5 years ago)
- Last Synced: 2025-01-30T21:35:18.260Z (8 months ago)
- Topics: api-rest, api-tests, python3, robotframework, template-project, tests
- Language: RobotFramework
- Homepage:
- Size: 16.6 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Template for Create and Run API tests using Robot Framework.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About Project](#about-project)
- [Starting](#starting)
- [Installation](#installation)
- [Languages used](#languages-used)
- [How To Use](#how-to-use)
- [Best Pratices](#best-pratices)
- [Files by directories](#files-by-directories)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## About Project
This is a template for make api tests using Robot Framework creating tests suite.
## Starting
### Installation
1. To install this project you can clone it and go to step 2. Or use the commands below:
```
npm install rest_api_test_automation_template
```
1.1 Extract the test project from the node_modules folder and save it in your preferred location.
2. This project ** requires Robot Framework installed **. Install the Robot using the steps below.
2.1. Install Python 3
```
https://www.python.org/downloads/
```
2.2. Install Robot Framework
```
pip3 install robotframework
```
2.3. Install HTTP Requests Library
```
pip3 install -U requests
pip3 install -U robotframework-requests
```
### Languages used
- [Robot Framework (Python Version)](https://robotframework.org/)
### How To Use
1. Run your all tests
```
robot -d ./logs tests
```
2. Run your test by test suite
```
robot -d ./logs tests/feature_name
```
### Best Pratices
1. Run yours tests using `-d ./logs` for organize log files.
2. Not remove Config example files.
3. create your Commons file according to your need.
### Files by directories
Below is a list of the files by directory.
| Directory | Files in folder |
| ----------------------: | ----------------------------------------------------------------------------- |
| `config` | **config_name.robot** All files used to configure your Robot tests, such as tokens and more. |
| `libs` | **lib_name.py** all Python files used to provide support in tests. |
| `common` | **common_filename.robot** All common codes used to make requests. |
| `tests` | **feature/suite_tests_name.robot** All tests files. |
## Contributing
Contributions are what make the open source community an incredible place to learn, inspire and create. Any contribution you make will be **much appreciated**.
1. Make a project Fork
2. Create a Branch for your feature (`git checkout -b feature/amazing-feature`)
3. Insert your changes (`git add .`)
4. Make a commit with your changes (`git commit -m 'feat(package-filename>): Inserting a Amazing Feature !`)
5. Push the branch (`git push origin feature/amazing-feature`)
6. Open a Pull Request
## License
Distributed under the MIT license. See `LICENSE` for more information.
## Contact
Yury Alencar - [Github](https://github.com/yuryalencar) - **yuryalencar19@gmail.com**