datastore/internal/api/server.gen.go
Luís Murta a52bca5882
Adapt API implementation with DAL interface
Swap direct access to the DB on the API server with an data abstraction
layer.
Implement each API type converter separately and revert changes to the
auto-generated server implementation types.

Add error return to DAL methods. Implement `Transactions`.

Add tools.go with oapi-codegen and mockgen.
https://www.jvt.me/posts/2022/06/15/go-tools-dependency-management/

Update go packages.

Issues #5, #12
2024-05-12 22:16:24 +01:00

296 lines
11 KiB
Go

// Package api provides primitives to interact with the openapi HTTP API.
//
// Code generated by github.com/deepmap/oapi-codegen/v2 version v2.1.0 DO NOT EDIT.
package api
import (
"bytes"
"compress/gzip"
"encoding/base64"
"fmt"
"net/http"
"net/url"
"path"
"strings"
"github.com/getkin/kin-openapi/openapi3"
"github.com/labstack/echo/v4"
"github.com/oapi-codegen/runtime"
openapi_types "github.com/oapi-codegen/runtime/types"
)
// Bank defines model for Bank.
type Bank struct {
Id string `json:"id"`
Name string `json:"name"`
NordigenId *openapi_types.UUID `json:"nordigenId,omitempty"`
}
// Banks defines model for Banks.
type Banks = []Bank
// Transaction defines model for Transaction.
type Transaction struct {
Category *string `json:"category,omitempty"`
Date openapi_types.Date `json:"date"`
Description string `json:"description"`
Id int64 `json:"id"`
Value float32 `json:"value"`
}
// Transactions defines model for Transactions.
type Transactions = []Transaction
// GetTransactionsParams defines parameters for GetTransactions.
type GetTransactionsParams struct {
// Category filter by transaction category
Category *string `form:"category,omitempty" json:"category,omitempty"`
// Limit number of transactions to return
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
// Offset offset from where to retrieve transactions
Offset *int32 `form:"offset,omitempty" json:"offset,omitempty"`
// Bank ID of the bank
Bank *string `form:"bank,omitempty" json:"bank,omitempty"`
// Sort field name by which to sort
Sort *string `form:"sort,omitempty" json:"sort,omitempty"`
}
// ServerInterface represents all server handlers.
type ServerInterface interface {
// Find bank by ID
// (GET /bank/{bankId})
GetBankById(ctx echo.Context, bankId int64) error
// Retrieve existing banks
// (GET /banks)
GetBanks(ctx echo.Context) error
// Find transaction by ID
// (GET /transaction/{transactionId})
GetTransactionById(ctx echo.Context, transactionId int64) error
// Retrieve existing transactions
// (GET /transactions)
GetTransactions(ctx echo.Context, params GetTransactionsParams) error
}
// ServerInterfaceWrapper converts echo contexts to parameters.
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
// GetBankById converts echo context to params.
func (w *ServerInterfaceWrapper) GetBankById(ctx echo.Context) error {
var err error
// ------------- Path parameter "bankId" -------------
var bankId int64
err = runtime.BindStyledParameterWithOptions("simple", "bankId", ctx.Param("bankId"), &bankId, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter bankId: %s", err))
}
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetBankById(ctx, bankId)
return err
}
// GetBanks converts echo context to params.
func (w *ServerInterfaceWrapper) GetBanks(ctx echo.Context) error {
var err error
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetBanks(ctx)
return err
}
// GetTransactionById converts echo context to params.
func (w *ServerInterfaceWrapper) GetTransactionById(ctx echo.Context) error {
var err error
// ------------- Path parameter "transactionId" -------------
var transactionId int64
err = runtime.BindStyledParameterWithOptions("simple", "transactionId", ctx.Param("transactionId"), &transactionId, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter transactionId: %s", err))
}
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetTransactionById(ctx, transactionId)
return err
}
// GetTransactions converts echo context to params.
func (w *ServerInterfaceWrapper) GetTransactions(ctx echo.Context) error {
var err error
// Parameter object where we will unmarshal all parameters from the context
var params GetTransactionsParams
// ------------- Optional query parameter "category" -------------
err = runtime.BindQueryParameter("form", true, false, "category", ctx.QueryParams(), &params.Category)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter category: %s", err))
}
// ------------- Optional query parameter "limit" -------------
err = runtime.BindQueryParameter("form", true, false, "limit", ctx.QueryParams(), &params.Limit)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter limit: %s", err))
}
// ------------- Optional query parameter "offset" -------------
err = runtime.BindQueryParameter("form", true, false, "offset", ctx.QueryParams(), &params.Offset)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter offset: %s", err))
}
// ------------- Optional query parameter "bank" -------------
err = runtime.BindQueryParameter("form", true, false, "bank", ctx.QueryParams(), &params.Bank)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter bank: %s", err))
}
// ------------- Optional query parameter "sort" -------------
err = runtime.BindQueryParameter("form", true, false, "sort", ctx.QueryParams(), &params.Sort)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter sort: %s", err))
}
// Invoke the callback with all the unmarshaled arguments
err = w.Handler.GetTransactions(ctx, params)
return err
}
// This is a simple interface which specifies echo.Route addition functions which
// are present on both echo.Echo and echo.Group, since we want to allow using
// either of them for path registration
type EchoRouter interface {
CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}
// RegisterHandlers adds each server route to the EchoRouter.
func RegisterHandlers(router EchoRouter, si ServerInterface) {
RegisterHandlersWithBaseURL(router, si, "")
}
// Registers handlers, and prepends BaseURL to the paths, so that the paths
// can be served under a prefix.
func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string) {
wrapper := ServerInterfaceWrapper{
Handler: si,
}
router.GET(baseURL+"/bank/:bankId", wrapper.GetBankById)
router.GET(baseURL+"/banks", wrapper.GetBanks)
router.GET(baseURL+"/transaction/:transactionId", wrapper.GetTransactionById)
router.GET(baseURL+"/transactions", wrapper.GetTransactions)
}
// Base64 encoded, gzipped, json marshaled Swagger object
var swaggerSpec = []string{
"H4sIAAAAAAAC/8xWTY/bNhD9KwTbo1bSxosedGqDRRYGinTRtKc0B1oayUz4oZBDu4bh/14MpbX1tfEW",
"aBe5eCVxOG/em8fhHnlpdWsNGPS8OHJfbkGL+PhWmC/0t3W2BYcS4ldZ0S8eWuAF9+ikafgp4UZoWF6w",
"rpINmHXcV1unBfKChyArnkzDTwl38DVIBxUvPvIYEjN/OofazWcokTJTfV1JCDo+/Oig5gX/IbtwynpC",
"WWRzOqcRzokDvf/hhPGiRGnNnGwpEBrrDovMKoEw4hQ/JAuB4Esn2yeI2bocSyMN/nTHE66lkTpoXuTn",
"nNIgNOBo006oMIavlRV4wTdBbyh0SdO+0mFhTxmXlB5o9HLBh8LOdKeqpKltFNkaFCXSI2ghFVGRRpgS",
"ftbBoUgr2M1k5I/gvDVCsXddLPsAbgfuL2KiZAnGR3U6X/KH93+yBzDghGKPYaNkyX7tgthulebMOqYE",
"guMJD44q2CK2vsiy/X6fNiak1jVZn9ZnTatuVml+41GYSihrIN2iVpGmRAVL5d2w31owvzyu2SrNSW1w",
"vmOSp3l6S3ttC0a0khd8lebpiie8FbiNQmcbYb5kR/pdVyf60kBUjNwqSBI6X/wBkHz+9rCu4m4nNCA4",
"z4uPx4l+63tma0YJGVrmAIMj6SStEezTySt4B8qHNkIXIOlnxaJ3p349faLtvrWkH+14k+dPvQcTmYi2",
"VbKMXLLPvjsqF4TrR/s0s8iHUJbgfR0UO8tEOt912BM9zE4oWbH1PfOBSoGqi72bxxIgMxZZbYOp4hHz",
"QWtBg4K/k6bqdN0c2Po+rsb2+Wtt8/x/Fsn/O5UWmL+3bNMnGnL+HdBJ2AGDv6VHaZpBVIaXQZAdBy9X",
"jDyYHy/38yD9NVuPKvmO3T2ao69o8gHut70+1HxgeZxcGi/os7/W5FoqBEcoQ9DzLd33+WuA+NI3erB8",
"UdwEpcSGRnXX7dk/IlPo7jqdeMzPTTYBV1JLHCFXUIugkBe3eZ6MvLV6c+XWn1dl69oDstpZzfZbcNAX",
"1J1GHEu7VF+XYLnAm9uF+q7X1J/ELcQh8Axuv3RBvdqAWoKqGG2n/u+3stwSWW8dPoPRLz2P8UrH9j8Z",
"uzjO9+3pOwk+nf4JAAD//62NJ7znCwAA",
}
// GetSwagger returns the content of the embedded swagger specification file
// or error if failed to decode
func decodeSpec() ([]byte, error) {
zipped, err := base64.StdEncoding.DecodeString(strings.Join(swaggerSpec, ""))
if err != nil {
return nil, fmt.Errorf("error base64 decoding spec: %w", err)
}
zr, err := gzip.NewReader(bytes.NewReader(zipped))
if err != nil {
return nil, fmt.Errorf("error decompressing spec: %w", err)
}
var buf bytes.Buffer
_, err = buf.ReadFrom(zr)
if err != nil {
return nil, fmt.Errorf("error decompressing spec: %w", err)
}
return buf.Bytes(), nil
}
var rawSpec = decodeSpecCached()
// a naive cached of a decoded swagger spec
func decodeSpecCached() func() ([]byte, error) {
data, err := decodeSpec()
return func() ([]byte, error) {
return data, err
}
}
// Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error) {
res := make(map[string]func() ([]byte, error))
if len(pathToFile) > 0 {
res[pathToFile] = rawSpec
}
return res
}
// GetSwagger returns the Swagger specification corresponding to the generated code
// in this file. The external references of Swagger specification are resolved.
// The logic of resolving external references is tightly connected to "import-mapping" feature.
// Externally referenced files must be embedded in the corresponding golang packages.
// Urls can be supported but this task was out of the scope.
func GetSwagger() (swagger *openapi3.T, err error) {
resolvePath := PathToRawSpec("")
loader := openapi3.NewLoader()
loader.IsExternalRefsAllowed = true
loader.ReadFromURIFunc = func(loader *openapi3.Loader, url *url.URL) ([]byte, error) {
pathToFile := url.String()
pathToFile = path.Clean(pathToFile)
getSpec, ok := resolvePath[pathToFile]
if !ok {
err1 := fmt.Errorf("path not found: %s", pathToFile)
return nil, err1
}
return getSpec()
}
var specData []byte
specData, err = rawSpec()
if err != nil {
return
}
swagger, err = loader.LoadFromData(specData)
if err != nil {
return
}
return
}