README
¶
rental-service
The service exposes two endpoints for requesting data:
GET /rentals/{id} - get rental by id
GET /rentals - list filtered rentals
Filters for listing:
ids- list of integers representing rental idsprice_min- integer value to filter for minimum priceprice_max- integer value to filter for maximum pricenear- 2 float values representing a locationsort- string value representing a field to order results bylimit- integer value to specify a pagination limitoffset- integer value to specify a pagination offset
Example queries:
rentals?ids=3,4,5
rentals?price_min=9000&price_max=75000
rentals?limit=3&offset=6
rentals?near=33.64,-117.93
rentals?sort=price
rentals?near=33.64,-117.93&price_min=9000&price_max=75000&limit=3&offset=6&sort=price
Run the tests
Install github.com/moq/moq to generate test mocks:
go install github.com/moq/moq@latest
Init environment file:
make init
Generate the mocks:
make generate
Run the tests:
make test
Run the service
Init environment file:
make init
Start the db:
make db-up
Run the service:
make server-start
Stop the database
make db-down
Stop the database and remove volumes
make volumes-down
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
module
|
|
|
rental/internal/db
Package db contains helper functions for working with db.
|
Package db contains helper functions for working with db. |
|
pkg
|
|
|
config
Package config contains configuration structs.
|
Package config contains configuration structs. |
|
logger
Package logger contains a sligthly extended version of the Zap logger.
|
Package logger contains a sligthly extended version of the Zap logger. |
Click to show internal directories.
Click to hide internal directories.