This documentation outlines the details of a simple REST API project that handles transaction data. The API is built using Express.js, Node.js, and TypeScript. It performs basic CRUD operations (Create, Read, Update, Delete) on transaction data.
The project aims to provide a straightforward API for managing transaction data. It is designed to be a foundational example for building more complex APIs in the future. By utilizing Express.js and TypeScript.
- Node.js: A JavaScript runtime that allows executing code on the server side.
- Express.js: A popular web application framework for Node.js that simplifies building APIs and web applications.
- TypeScript: A superset of JavaScript that adds static typing for enhanced code quality and maintainability.
-
GET /transactions Retrieve a list of all transactions.
-
GET /transactions/:id Retrieve details about a specific transaction based on its ID.
-
POST /transactions Create a new transaction using the provided data.
-
PUT /transactions/:id Fully update an existing transaction identified by its ID.
-
PATCH /transactions/:id Partially update an existing transaction identified by its ID.
-
DELETE /transactions/:id Delete a transaction based on its ID.