Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sadmanpieal/restful-booker-api

A comprehensive automation suite for testing the RESTful Booker API. This repository contains automated tests created with Postman and executed using Newman, covering essential endpoints for managing bookings, including creating, updating, retrieving, and deleting bookings. Ideal for ensuring the reliability and correctness of RESTful APIs.
https://github.com/sadmanpieal/restful-booker-api

api newman newman-reporter-htmlextra postman rest-api

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/sadmanpieal/restful-booker-api
Owner: sadmanpieal
Created: 2024-08-21T09:15:31.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-08-21T15:37:48.000Z (4 months ago)
Last Synced: 2024-10-13T11:21:52.844Z (2 months ago)
Topics: api, newman, newman-reporter-htmlextra, postman, rest-api
Language: HTML
Homepage: https://restful-booker.herokuapp.com/apidoc/index.html
Size: 12.5 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# RESTful Booker API Automation

This repository contains automated tests for the Restful Booker API. The tests are written using [Postman](https://www.postman.com/) and executed with [Newman](https://www.npmjs.com/package/newman).

## Table of Contents

- [Overview](#overview)
- [API Endpoints Covered](#api-endpoints-covered)
- [Setup Instructions](#setup-instructions)
- [Running the Tests](#running-the-tests)
- [Contributing](#contributing)
- [License](#license)

## Overview

The Restful Booker API provides a set of endpoints for managing bookings, including creating, updating, retrieving, and deleting bookings. This project automates the testing of these endpoints to ensure their correctness and reliability.

## API Endpoints Covered

The following API endpoints are covered in the automation:

- **Auth**
- `POST /auth`: Create a new authentication token.

- **Booking**
- `GET /booking`: Retrieve a list of booking IDs.
- `GET /booking/:id`: Retrieve the details of a specific booking.
- `POST /booking`: Create a new booking.
- `PUT /booking/:id`: Update an existing booking.
- `PATCH /booking/:id`: Partially update an existing booking.
- `DELETE /booking/:id`: Delete a booking.

## Setup Instructions

### Prerequisites

- [Node.js](https://nodejs.org/) installed on your machine.
- [Newman](https://www.npmjs.com/package/newman) installed globally:
```bash
npm install -g newman
```
- [Postman](https://www.postman.com/) installed for running and modifying the collections.

### Cloning the Repository

Clone this repository to your local machine:

```bash
git clone https://github.com/sadmanpieal/Restfull-Booker-API-.git
cd Restfull-Booker-API-
```

## Running the Tests

To run the tests using Newman, use the following command:

```bash
newman run Restful-booker.postman_collection.json
```
or
```bash
newman run Restful-booker.postman_collection.json --env-var "variable_name=variable_value"
```

- If your collection requires environment variables but you don't want to use an environment file, you can pass individual variables directly in the command line using the --env-var option:

### Running with HTML Report

If you wish to generate an HTML report after running the tests, use:

```bash
node .\reports.js
```
- before that delete the report.html file from Reports folder
- The report will be saved as `report.html`.
- Report will look like this

![screencapture-file-D-Restfull-booker-Restfull-Booker-API-Reports-report-html-2024-08-21-21_27_04](https://github.com/user-attachments/assets/80b0d196-c5f3-4465-a7c8-ca5863f5b455)

## Contributing

If you would like to contribute to this project, please fork the repository and submit a pull request. All contributions are welcome!

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.