Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sadmanpieal/cryptocurrecy-wallet-api
Cryptocurrency Wallet API provides endpoints for managing user wallets, transactions, and exchange rates. It includes automated tests using Postman and Newman to ensure reliability. The API supports operations such as user registration, balance retrieval, transaction processing, and more.
https://github.com/sadmanpieal/cryptocurrecy-wallet-api
javascript newman newman-reporter-htmlextra nodejs postman test-automation testing-framework
Last synced: about 1 month ago
JSON representation
Cryptocurrency Wallet API provides endpoints for managing user wallets, transactions, and exchange rates. It includes automated tests using Postman and Newman to ensure reliability. The API supports operations such as user registration, balance retrieval, transaction processing, and more.
- Host: GitHub
- URL: https://github.com/sadmanpieal/cryptocurrecy-wallet-api
- Owner: sadmanpieal
- Created: 2024-08-25T06:16:02.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T06:45:59.000Z (3 months ago)
- Last Synced: 2024-10-12T11:05:59.983Z (about 1 month ago)
- Topics: javascript, newman, newman-reporter-htmlextra, nodejs, postman, test-automation, testing-framework
- Language: HTML
- Homepage: https://app.beeceptor.com/mock-server/crypto-wallet-server
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cryptocurrency Wallet API
This repository contains the implementation and automated tests for the Cryptocurrency Wallet API. The API is designed to manage user wallets, facilitate transactions, and provide essential cryptocurrency-related functionalities. The tests are crafted using Postman and executed with Newman, ensuring comprehensive coverage and reliability of the API endpoints.
## Table of Contents
- [Overview](#overview)
- [API Endpoints Covered](#api-endpoints-covered)
- [Tools Used](#tools-used)
- [Setup Instructions](#setup-instructions)
- [Running the Tests](#running-the-tests)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Overview
The Cryptocurrency Wallet API offers a range of endpoints for managing cryptocurrency transactions, including user registration, wallet balance retrieval, transaction processing, and exchange rate queries. This project automates the testing of these endpoints to ensure the API's functionality, reliability, and consistency.
## API Endpoints Covered
The following API endpoints are covered in the automation:
### User Management
- `200 POST /api/v1/register`: Register a user, and create their wallet.
- `200 POST /api/v1/login`: Login the user and generate a session token.
### Wallet Operations
- `200 GET /api/v1/balance`: Retrieve the wallet balance.
### Transactions
- `200 GET /api/v1/transactions`: List all the transactions done by the user.
- `200 POST /api/v1/transactions`: Transfer 5 ETH to a recipient.
- `200 POST /api/v1/transaction_fee`: Calculate transaction fees and return estimated cost.
### Exchange Rates
- `200 GET /api/v1/exchange_rates`: Get an object with all available currency exchange rates.
## Tools Used
- **Postman**: Used for creating, organizing, and running the API test cases.
- **Newman**: A command-line tool used to run Postman collections in various environments and integrate them into CI/CD pipelines.
## Setup Instructions
### Prerequisites
- **Node.js** installed on your machine.
- **Newman** installed globally:
```bash
npm install -g newman
### Cloning the Repository
Clone this repository to your local machine:
```bash
git clone https://github.com/sadmanpieal/Cryptocurrecy-Wallet-API.git
cd Cryptocurrecy-Wallet-API
```
## Running the Tests
To run the tests using Newman, use the following command:
```bash
newman run Cryptocurrency Wallet API.postman_collection.json
```
This command will execute the entire suite of tests against the API.
### Running with HTML Report
If you wish to generate an HTML report after running the tests, use:
```bash
newman run Cryptocurrency Wallet API.postman_collection.json -r html --reporter-html-export newman-report.html
```
The report will be saved as `newman-report.html`.
## Project Structure
The repository is structured as follows:
```
Cryptocurrency-Wallet-API/
│
├── Cryptocurrency-Wallet-API.postman_collection.json # Postman collection file containing all API requests and tests.
├── newman/ # Folder containing Newman reports and other artifacts (if applicable).
└── README.md # Project documentation (this file).
```
## 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.