httputil

Documentation

Overview

Package httputil represents the http responses documentation.

Index

• type HttpBadRequestErr
• type HttpInternalServerErr
• type HttpOkWithMessage
• type PingInternalServerErr
• type PingOk

Types

type HttpBadRequestErr

type HttpBadRequestErr struct {
	Message string `json:"error" example:"bad request"`
}

HttpBadRequestErr returns a error message

type HttpInternalServerErr

type HttpInternalServerErr struct {
	Message string `json:"error" example:"internal server error"`
}

HttpInternalServerErr returns a error message

type HttpOkWithMessage

type HttpOkWithMessage struct {
	Message string `json:"message" example:"feedback message"`
}

HttpOkWithMessage returns a 200 response with a message

type PingInternalServerErr

type PingInternalServerErr struct {
	Message string `json:"message" example:"unexpected error"`
}

PingInternalServerErr example

type PingOk

type PingOk struct {
	Message string `json:"message" example:"pong"`
}

PinkOk example