README
¶
Golang-API
This repository contains a set of small packages we use at MWM to build restfull APIs.
- errors
- log
- middleware
- server
- stacktrace
Examples
You can see examples implementations in the examples folder:
- a Hello-world example showing you the basics (examples/hello-world)
- a Google Cloud Platform Logger example showing you how to setup a cloud-logging logger (examples/gcp-logger)
- a CRUD example showing you how to make a CRUD with this library (examples/crud)
Directories
¶
| Path | Synopsis |
|---|---|
|
Package errors provides a generic error carrying useful information:
|
Package errors provides a generic error carrying useful information: |
|
google
Package google provides and registers error builders to interpret google errors into gapi errors.
|
Package google provides and registers error builders to interpret google errors into gapi errors. |
|
examples
|
|
|
1-hello-world
module
|
|
|
2-encoders
module
|
|
|
3-params
module
|
|
|
4-doc-openapi
module
|
|
|
Package log provides a simple and extensible logger.
|
Package log provides a simple and extensible logger. |
|
Package middleware provides you multiple generic middlewares to use to enhance your http handlers.
|
Package middleware provides you multiple generic middlewares to use to enhance your http handlers. |
|
Package openapi provides helper functions to use github.com/swaggest/openapi-go/openapi3 more easily.
|
Package openapi provides helper functions to use github.com/swaggest/openapi-go/openapi3 more easily. |
|
Package server provides a simple router based https://github.com/gorilla/mux, with a SpecOpenAPIHandler type return the response (not serialized) and an error, as well as a Middleware type to allow middleware for this new SpecOpenAPIHandler type.
|
Package server provides a simple router based https://github.com/gorilla/mux, with a SpecOpenAPIHandler type return the response (not serialized) and an error, as well as a Middleware type to allow middleware for this new SpecOpenAPIHandler type. |
|
Package stacktrace provides you a StackTrace type that contains both the list of the runtime.Frame of the stacktrace, and the printed format fo debug.Stack(), so you can choose which format you want to use.
|
Package stacktrace provides you a StackTrace type that contains both the list of the runtime.Frame of the stacktrace, and the printed format fo debug.Stack(), so you can choose which format you want to use. |
Click to show internal directories.
Click to hide internal directories.