api

package

v0.0.0-...-68a5074 Latest Latest Go to latest Published: Mar 11, 2023 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/crafting-demo/backend-go-gin

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ApiHandler(request RequestMessage, response *ResponseMessage) error
func BadRequest(c *gin.Context)
func GinRun(ctx Context)
func HttpHandler(c *gin.Context)
func InternalServerError(c *gin.Context)
func KafkaHandler(message RequestMessage)
func KafkaRun()
func NotFound(c *gin.Context)
func ReadEntity(store string, key string) (string, error)
func WriteEntity(store string, key string, value string) error
type Context
type Error
type RequestMessage
type ResponseMessage

Constants ¶

View Source

const (
	Hello = "Hello! How are you?"
	Echo  = "Please echo"
	Read  = "Read from database"
	Write = "Write to database"
)

MessageType.

Variables ¶

This section is empty.

Functions ¶

func ApiHandler ¶

func ApiHandler(request RequestMessage, response *ResponseMessage) error

ApiHandler handles a "nested call" API.

func BadRequest ¶

func BadRequest(c *gin.Context)

func GinRun ¶

func GinRun(ctx Context)

func HttpHandler ¶

func HttpHandler(c *gin.Context)

func InternalServerError ¶

func InternalServerError(c *gin.Context)

func KafkaHandler ¶

func KafkaHandler(message RequestMessage)

func KafkaRun ¶

func KafkaRun()

func NotFound ¶

func NotFound(c *gin.Context)

func ReadEntity ¶

func ReadEntity(store string, key string) (string, error)

ReadEntity returns value of key from some data store.

func WriteEntity ¶

func WriteEntity(store string, key string, value string) error

WriteEntity writes a key/value pair to some data store.

Types ¶

type Context ¶

type Context struct {
	Mode string
	Port string
}

type Error ¶

type Error struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

type RequestMessage ¶

type RequestMessage struct {
	CallTime string `json:"callTime"`
	Target   string `json:"target"`
	Message  string `json:"message"`
	Key      string `json:"key,omitempty"`
	Value    string `json:"value,omitempty"`
}

type ResponseMessage ¶

type ResponseMessage struct {
	ReceivedTime string `json:"receivedTime"`
	ReturnTime   string `json:"returnTime"`
	Message      string `json:"message"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL