README
¶
Plantbook, plants social network.
For generate plantbook-server
nedd to be installed go-swagger#install
# after change spec run command below...
swagger generate server -t internal/api -A plantbook -f ./api/swagger/swagger.yaml --main-package=../../../cmd/plantbook-server
# for help type: swagger generate server --help
-t internal/api # path for put generated files
-A plantbook # application name
-f ./api/swagger/swagger.yaml # path to swagger speca
--main-package=../../../cmd/plantbook-server # path for put main file location
Contents
1. Introduction
Plantbook is an online service that intended for the plant owners and gardeners who look for a tool that would allow them to take care about their plants better. Every plant can optionally have a name and eventually a blog about its life, that can contain photos, some sad or happy stories.
2. Components
3. Main classes
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
api/client
Package client implement client requests to plantbook-server
|
Package client implement client requests to plantbook-server |
|
api/handlers
Package handlers contains common const and vars for all handlers
|
Package handlers contains common const and vars for all handlers |
|
api/handlers/gardens
Package gardens contains http Handlers for gardens
|
Package gardens contains http Handlers for gardens |
|
api/handlers/health
Package health contains handler implementations of the ./internal/api/restapi/operations/health
|
Package health contains handler implementations of the ./internal/api/restapi/operations/health |
|
api/handlers/users
Package users contains handler implementations of the ./internal/api/restapi/operations/user
|
Package users contains handler implementations of the ./internal/api/restapi/operations/user |
|
api/middleware
Package middleware contains http.Handler functions
|
Package middleware contains http.Handler functions |
|
api/repo
Package repo contains implementations of the repository interfaces
|
Package repo contains implementations of the repository interfaces |
|
api/restapi
Package restapi Plantbook
|
Package restapi Plantbook |
|
config
Package config implements common config method and variable for plantbook project
|
Package config implements common config method and variable for plantbook project |
|
metric
Package metric contains http server for prometheus /metrics handler
|
Package metric contains http server for prometheus /metrics handler |
|
pkg
|
|
|
logging
Package logging sets up and configures logging.
|
Package logging sets up and configures logging. |
|
utils
|
|
|
randutil
Package randutil contains functions generate random sequences of runes or bytes
|
Package randutil contains functions generate random sequences of runes or bytes |
Click to show internal directories.
Click to hide internal directories.