https://github.com/loiane/copilot-demo
https://github.com/loiane/copilot-demo
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/loiane/copilot-demo
- Owner: loiane
- Created: 2024-05-13T23:12:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-15T20:51:08.000Z (over 1 year ago)
- Last Synced: 2025-03-01T23:11:38.947Z (7 months ago)
- Language: Java
- Size: 30.3 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Documentation for Products Endpoint
## GET /api/products
This endpoint returns a list of all available products in the system.
### Response Format
The response is formatted as JSON and includes an array of products. Each product object contains the following information:
- `id`: Unique product ID (Long)
- `name`: Name of the product (String, 3-100 characters)
- `description`: Brief summary of the product (String, 0-500 characters, optional)
- `price`: Price of the product (BigDecimal)### Example Response
```json
[
{
"id": 12345,
"name": "Awesome T-Shirt",
"description": "The most comfortable t-shirt you'll ever wear.",
"price": 19.99
},
{
"id": 54321,
"name": "Stylish Jeans",
"description": "Classic denim jeans with a modern fit.",
"price": 49.99
}
]
```### Additional Notes
- The API uses Hibernate validation for request parameters.
- The API follows a package-by-domain organization, including a Controller layer, a Service layer, model, and repository.