https://github.com/stefruseva88/restapi-github-tests

GitHub Rest API Tests
https://github.com/stefruseva88/restapi-github-tests

github-api nunit-tests rest-api rest-client test-automation

Last synced: 27 days ago
JSON representation

GitHub Rest API Tests

• Host: GitHub
• URL: https://github.com/stefruseva88/restapi-github-tests
• Owner: StefRuseva88
• License: mit
• Created: 2024-04-12T14:04:11.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-11-28T17:31:00.000Z (about 1 month ago)
• Last Synced: 2024-11-28T18:32:58.879Z (about 1 month ago)
• Topics: github-api, nunit-tests, rest-api, rest-client, test-automation
• Language: C#
• Homepage:
• Size: 73.2 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Rest API GitHub Tests

[![C#](https://img.shields.io/badge/Made%20with-C%23-239120.svg)](https://learn.microsoft.com/en-us/dotnet/csharp/)

[![.NET](https://img.shields.io/badge/.NET-5C2D91.svg)](https://dotnet.microsoft.com/)

[![GitHub](https://img.shields.io/badge/GitHub-181717.svg)](https://github.com/)

[![REST API](https://img.shields.io/badge/API-REST-blue.svg)](https://en.wikipedia.org/wiki/Representational_state_transfer)

[![RestSharp](https://img.shields.io/badge/Library-RestSharp-008080.svg)](https://restsharp.dev/)

[![NUnit](https://img.shields.io/badge/tested%20with-NUnit-22B2B0.svg)](https://nunit.org/)

### This is a test project for **Back-End Test Automation** March 2024 Course @ SoftUni

---

## Project Description

This project is designed to test various functionalities of the GitHub API using RestSharp and NUnit. The purpose is to automate the testing of RESTful web services to ensure they work correctly and handle errors gracefully.

## Technologies Used

- **RestSharp**: A powerful library to simplify HTTP requests in .NET.

- **NUnit**: A popular unit testing framework for .NET applications.

## GitHub API Endpoints

- GitHub Issues provides the standard RESTful API endpoints, which you can access with HTTP client from [GitHub API edndpoints](https://api.github.com)

- This project tests various endpoints of the GitHub API.

- For a full list of available endpoints, refer to the [GitHub API documentation](https://docs.github.com/en/rest)

## GitHub API Project 

- **RestSharpServices**: Methods that interact with the GitHub API using RestSharp.

- **TestGitHubApi**: Tests to verify the functionality of the RestSharpServices methods.

- **Models**: These classes represent the data that the GitHub API will send and receive.

## Setting Up the RestSharp Client

The constructor takes three parameters:

- **BaseUrl**: The root URL of the GitHub API. This is where all API requests will start from.

- **Username**: Your GitHub username.

- **Token**: Your GitHub personal access token. This is used for authentication and allows you to interact with the GitHub API.

## Implementing API Methods and Tests

 **Incremental Approach**: To use this apprach you have to write one method, then immediately write the corresponding test to validate it. Then Repeat this process for each method. This approach helps to focus on one piece of functionality at a time and makes debugging easier.

## License

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

## Contact

For any questions or suggestions, please reach out to me or open an issue in the repository.

---

### Happy Testing! 🚀