README
¶
HZPaste (REST API)
HZPaste is a simple REST API app, which serves source code snippets.
HZPaste uses gin web framework.
By default HZPaste runs on port :8888
Configuration
HZPaste server can be configured using the environment variables:
$ export HZPASTE_HOST=0.0.0.0
$ export HZPASTE_PORT=9090
Run tests
make test
Run debug verion
make run
Run release verion
make release
Generate swagger docs
make swag-init
Endpoints and features
UI
There is an amazing UI for hzpaste backend:
https://github.com/AlenaMaer/pastecodes
Swagger
HZPaste provides swagger documentation:
http://localhost:8888/swagger/index.html
PGC
HZPaste has PGC (Paste Garbage Collector), that sweeps and removes obsolete pastes from it's storage.
Books
I'm in love with books. If you want to thank me, just help me to buy books from the list
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd contains the executable commands for this project.
|
Package cmd contains the executable commands for this project. |
|
hzpaste-api
The hzpaste-api is a service for managing source code snippents.
|
The hzpaste-api is a service for managing source code snippents. |
|
hzpaste-api/internal
Package internal contains packages that are only relevant to the hzpaste-api command.
|
Package internal contains packages that are only relevant to the hzpaste-api command. |
|
hzpaste-api/internal/docs
Package docs contains the swagger documentation for hzpaste API
|
Package docs contains the swagger documentation for hzpaste API |
|
hzpaste-api/internal/handlers
Package handlers provides the translation between the HTTP layer and application business logic.
|
Package handlers provides the translation between the HTTP layer and application business logic. |
|
internal
|
|
|
paste
Package pastes implements business logic.
|
Package pastes implements business logic. |
Click to show internal directories.
Click to hide internal directories.