api

package

v0.0.0-...-f5eeede Latest Latest Go to latest Published: Jul 7, 2022 License: Apache-2.0 Imports: 6 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/amandinedrebes/orness

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func InitAPI(ip, port string)
func NewError(text string) error
type API
- func (api *API) SendError(w http.ResponseWriter, errorCode int, message string, httpStatus int)
- func (api *API) SetDefaultHeader(w http.ResponseWriter, req *http.Request)
type APIError

Constants ¶

View Source

const (
	//APIErrorBodyParsing parsing body issue
	APIErrorBodyParsing = 1
	//APIErrorDatabase Database connexion issue
	APIErrorDatabase = 2
	//APIErrorInvalidValue invalid parameter
	APIErrorInvalidValue = 3

	//URLNotes
	URLNotes = "/notes"
)

Variables ¶

This section is empty.

Functions ¶

func InitAPI ¶

func InitAPI(ip, port string)

InitAPI start API connection

func NewError ¶

func NewError(text string) error

NewError raise an error

Types ¶

type API ¶

type API struct {
	APIIP    string
	APIPort  string
	Database *core.Database
}

API description of the web API

func (*API) SendError ¶

func (api *API) SendError(w http.ResponseWriter, errorCode int, message string, httpStatus int)

SendError standardization of API Error message

func (*API) SetDefaultHeader ¶

func (api *API) SetDefaultHeader(w http.ResponseWriter, req *http.Request)

SetDefaultHeader set http headers

type APIError ¶

type APIError struct {
	Code    int    `json:"code"` //errorCode
	Message string `json:"message"`
}

APIError Message error code

Source Files ¶

View all Source files

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