Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/strvcom/strv-backend-go-net
Go package facilitating writing API applications in a fast and easy manner.
https://github.com/strvcom/strv-backend-go-net
go golang handler http net server
Last synced: about 2 months ago
JSON representation
Go package facilitating writing API applications in a fast and easy manner.
- Host: GitHub
- URL: https://github.com/strvcom/strv-backend-go-net
- Owner: strvcom
- License: bsd-3-clause
- Created: 2022-06-16T11:51:47.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-30T07:00:42.000Z (3 months ago)
- Last Synced: 2024-11-07T23:42:39.416Z (2 months ago)
- Topics: go, golang, handler, http, net, server
- Language: Go
- Homepage: https://go.strv.io
- Size: 128 KB
- Stars: 6
- Watchers: 18
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# STRV net
![Latest release][release]
[![codecov][codecov-img]][codecov]
![GitHub][license]
Go package facilitating writing API applications in a fast and easy manner.
## Available packages
### errors
Definition of common errors.
### net
Common functionality that comes in handy regardless of the used API architecture. `net` currently supports generating request IDs with some helper methods.
### http
Wrapper around the Go native http server. `http` defines the `Server` that can be configured by the `ServerConfig`. Implemented features:
- Started http server can be easily stopped by cancelling the context that is passed by the `Run` method.
- The `Server` can be configured with a slog.Logger for logging important information during starting/ending of the server.
- The `Server` listens for `SIGINT` and `SIGTERM` signals so it can be stopped by firing the signal.
- By the `ServerConfig` can be configured functions to be called before the `Server` ends.
`http` defines several helper consctructs:
- Content types and headers which are frequently used by APIs.
- Middlewares:
- `RequestIDMiddleware` sets request id in to the context.
- `RecoverMiddleware` recovers from panic and sets panic object into the response writer for logging.
- `LoggingMiddleware` logs information about the request (method, path, status code, request id, duration of the request, error message and panic message).
- Method `WriteResponse` for writing a http response and `WriteErrorResponse` for writing an error http response. Writing of responses can be configured by `ResponseOption`.
## Examples
### http
Starting the server:
```go
package main
import (
...
httpx "go.strv.io/net/http"
)
func main() {
...
h := slog.NewJSONHandler(os.Stderr, &slog.HandlerOptions{
Level: level,
ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
if a.Key == slog.TimeKey {
a.Value = slog.StringValue(a.Value.Time().Format("2006-01-02T15:04:05.000Z"))
}
return a
},
})
l := slog.New(h)
serverConfig := httpx.ServerConfig{
Addr: ":8080",
Handler: handler(), // define your http handler
Hooks: httpx.ServerHooks{
BeforeShutdown: []httpx.ServerHookFunc{
func(_ context.Context) {
storage.Close() // it may be useful for example to close a storage before the server ends
},
},
},
Limits: nil,
Logger: l.WithGroup("httpx.Server"), // the server expects *slog.Logger
}
server := httpx.NewServer(&serverConfig)
if err = server.Start(ctx); err != nil {
l.Error("HTTP server unexpectedly ended", slog.Any("error", err))
}
}
```
Writing http responses:
```go
func (h *Handler) GetUser(w http.ResponseWriter, r *http.Request) {
userID := userIDFromCtx(r.Context())
user, err := h.service.GetUser(r.Context(), userID)
if err != nil {
_ = httpx.WriteErrorResponse(w, http.StatusInternalServerError, httpx.WithErrorCode("ERR_UNKNOWN"))
return
}
userResp := model.ToUser(user)
_ = httpx.WriteResponse(w, userResp, http.StatusOK)
}
```
[release]: https://img.shields.io/github/v/release/strvcom/strv-backend-go-net
[codecov]: https://codecov.io/gh/strvcom/strv-backend-go-net
[codecov-img]: https://codecov.io/gh/strvcom/strv-backend-go-net/branch/master/graph/badge.svg?token=QI6YW1E4TC
[license]: https://img.shields.io/github/license/strvcom/strv-backend-go-net