README
¶
Harvester API
A fast modern API for storing your resources
Running Locally
Prerequisites:
- Go 1.22.4
- Docker
- make
# Start the API
make compose-up
# Stop and destory the API
make compose-down
API Endpoints
When running locally host is available at localhost:3000
Postman collection included in root directory with examples
Users:
| Method | Endpoint |
|---|---|
| POST | /v1/users/ |
| GET | /v1/users/ |
| GET | /v1/users/:id |
| PUT | /v1/users/:id |
| PUT | /v1/users/role/:id |
| DELETE | /v1/users/:id |
Galaxies:
| Method | Endpoint |
|---|---|
| POST | /v1/galaxies/ |
| GET | /v1/galaxies/ |
| GET | /v1/galaxies/:id |
| GET | /v1/galaxies/name/:name |
| PUT | /v1/galaxies/:id |
| DELETE | /v1/galaxies/:id |
Resources:
| Method | Endpoint |
|---|---|
| POST | /v1/resources/ |
| GET | /v1/resources/ |
| GET | /v1/resources/:id |
| GET | /v1/resources/name/:name |
| PUT | /v1/resources/:id |
| DELETE | /v1/resources/:id |
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
domain/http/galaxyapi
Package galaxyapi maintains the web based api for resource access.
|
Package galaxyapi maintains the web based api for resource access. |
|
domain/http/resourceapi
Package resourceapi maintains the web based api for resource access.
|
Package resourceapi maintains the web based api for resource access. |
|
domain/http/userapi
Package userapi maintains the web based api for user access.
|
Package userapi maintains the web based api for user access. |
|
sdk/http/mux
Package mux provides support to bind domain level routes to the application mux.
|
Package mux provides support to bind domain level routes to the application mux. |
|
app
|
|
|
sdk/page
Package page provides support for query paging.
|
Package page provides support for query paging. |
|
business
|
|
|
sdk/migrate
Package migrate contains the database schema, migrations and seeding data.
|
Package migrate contains the database schema, migrations and seeding data. |
|
sdk/sqldb
Package sqldb provides support for access the database.
|
Package sqldb provides support for access the database. |
|
sdk/sqldb/dbarray
Package dbarray provides support for database array types.
|
Package dbarray provides support for database array types. |
|
foundation
|
|
|
logger
Package logger provides support for initializing the log system.
|
Package logger provides support for initializing the log system. |
|
validate
Package validate contains the support for validating models.
|
Package validate contains the support for validating models. |
Click to show internal directories.
Click to hide internal directories.