Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/isabelleysseric/productsapirestproject
ProductsApiRestProject is a simple REST API interface built using ASP.NET Core to manage products and items in a retail or inventory system. This project implements CRUD (Create, Read, Update, Delete) operations for products and items, using .NET 8 technologies.
https://github.com/isabelleysseric/productsapirestproject
Last synced: 8 days ago
JSON representation
ProductsApiRestProject is a simple REST API interface built using ASP.NET Core to manage products and items in a retail or inventory system. This project implements CRUD (Create, Read, Update, Delete) operations for products and items, using .NET 8 technologies.
- Host: GitHub
- URL: https://github.com/isabelleysseric/productsapirestproject
- Owner: isabelleysseric
- License: mit
- Created: 2024-08-23T20:27:53.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-09-10T20:13:15.000Z (2 months ago)
- Last Synced: 2024-09-11T21:10:22.625Z (2 months ago)
- Language: C#
- Size: 105 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Products API-Rest Project
## Author
[Isabelle Eysseric](https://github.com/isabelleysseric)
## Project description
Products Api Rest Project is a RESTful API built with ASP.NET Core that allows you to manage two main entities: `Products` and `Items`. This project also includes complete documentation generated with Sphinx, available in multiple formats, including HTML and PDF.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Clone the Repository](#clone-the-repository)
- [Install Dependencies](#install-dependencies)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Request Examples](#request-examples)
- [Generating Documentation](#generating-documentation)
- [HTML Documentation](#html-documentation)
- [PDF Documentation](#pdf-documentation)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Item Management**:
- Retrieve all items
- Retrieve a specific item by ID
- Add a new item
- Update an existing item
- Delete an item
- **Product Management**:
- Retrieve all products
- Retrieve a specific product by ID
- Add a new product
- Update an existing product
- Delete a product
- **Documentation**:
- Project documentation generated with Sphinx.
- Available formats: HTML, PDF.
## Installation
### Prerequisites
- [.NET Core SDK](https://dotnet.microsoft.com/download)
- [Python 3.x](https://www.python.org/downloads/) and [pip](https://pip.pypa.io/en/stable/installation/)
- [Sphinx](https://www.sphinx-doc.org/en/master/) and [sphinx-intl](https://sphinx-intl.readthedocs.io/en/latest/) (for documentation)
- [MikTeX](https://miktex.org/download) (Windows) or [TeX Live](https://www.tug.org/texlive/) (Linux/macOS) for PDF generation
### Clone the Repository
```bash
git clone https://github.com/your-username/ProductsApiRestProject.git
cd ProductsApiRestProject
```
### Install Dependencies
Install .NET Dependencies:
```bash
dotnet restore
```
Install Python Dependencies for Sphinx:
```bash
pip install -r requirements.txt
```
## Usage
To start the API, run the following command:
```bash
dotnet run
```
The API will be accessible at `http://localhost:5000`.
### API Endpoints
#### Items
| Method | Endpoint | Description |
| ------ | ----------------- | ------------------------------ |
| GET | `/api/items` | Retrieve all items |
| GET | `/api/items/{id}` | Retrieve a specific item by ID |
| POST | `/api/items` | Add a new item |
| PUT | `/api/items/{id}` | Update an existing item |
| DELETE | `/api/items/{id}` | Delete an item |
#### Products
| Method | Endpoint | Description |
| ------ | -------------------- | --------------------------------- |
| GET | `/api/products` | Retrieve all products |
| GET | `/api/products/{id}` | Retrieve a specific product by ID |
| POST | `/api/products` | Add a new product |
| PUT | `/api/products/{id}` | Update an existing product |
| DELETE | `/api/products/{id}` | Delete a product |
### Request Examples
#### Retrieve All Items
```bash
curl -X GET http://localhost:5000/api/items
```
#### Add a New Product
```bash
curl -X POST http://localhost:5000/api/products \
-H "Content-Type: application/json" \
-d '{
"name": "New Product",
"description": "This is a new product",
"price": 19.99
}'
```
## Generating Documentation
### HTML Documentation
To generate the documentation in HTML format:
```bash
sphinx-build -b html source/ _build/html
```
The HTML files will be available in the `_build/html` directory.
### PDF Documentation
To generate the documentation in PDF format, make sure you have a LaTeX distribution installed (MikTeX or TeX Live).
```bash
sphinx-build -b latex source/ _build/latex
cd _build/latex
pdflatex ProductsApiRestProject.tex
```The PDF file will be generated in the `_build/latex` directory.
```
## Project Structure
```
ProductsApiRestProject/
│
├── doc/
│ └── locale/
│ ├── .doctrees/
│ ├── en/
│ ├── fr/
│ ├── index.pot
│ ├── installation.pot
│ └── usage.pot
│
├── source/
│ ├── _static/
│ ├── _templates/
│ ├── conf.py
│ ├── index.rst
│ ├── installation.rst
│ └── usage.rst
│
├── Controllers/
│ ├── HomeController.cs
│ ├── ItemsController.cs
│ └── ProductsController.cs
│
├── Models/
│ ├── ItemDto.cs
│ └── ProductDto.cs
│
├── Services/
│ ├── ItemService.cs
│ ├── IItemService.cs
│ ├── ProductService.cs
│ └── IProductService.cs
│
├── wwwroot/
│ └── favicon.ico
│
│── .gitignore
│── make.bat
├── Makefile
├── ProductsApiRestProject.csproj
├── Startup.cs
├── Program.cs
└── README.md
```
This `README.md` file is designed to be comprehensive and user-friendly, providing all the necessary information to install, use, and contribute to `MyApiProject`.
## Contributing
Contributions are welcome! To contribute:
1. Fork the repository.
2. Create a new branch for your feature (`git checkout -b feature/your-feature`).
3. Commit your changes (`git commit -am 'Add a new feature'`).
4. Push the branch (`git push origin feature/your-feature`).
5. Create a Pull Request.
Please follow the coding conventions and document your changes.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/isabelleysseric/ProductsApiRestProject/blob/master/LICENSE) file for details.