Categorygithub.com/gofast-pkg/api
modulepackage
0.0.2
Repository: https://github.com/gofast-pkg/api.git
Documentation: pkg.go.dev

# README

API

Static Badge Build Go Reference codecov Release Go Report Card codebeat badge License

API is a package to provide http server with commons features. The core use the echo framework.

Install

$> go get github.com/gofast-pkg/api@latest

Usage

// Read documentation for more details usages
// With New(), api assume that you initialize the configuration with viper.
// Else, call the NewWithConfig() method to get you api instance.
import (
    "github.com/spf13/viper"
    "github.com/go-fast/api"
)

func main() {
    viper.AutomaticEnv()

    api, err := server.New()
    if err != nil {
        panic(err)
    }
    if err = s.Start(); err != nil {
        panic(err)
    }
}

Contributing

 :grey_exclamation:  Use issues for everything

Read more informations with the CONTRIBUTING_GUIDE

For all changes, please update the CHANGELOG.txt file by replacing the existant content.

Thank you  :pray:  :+1: 

Made with contrib.rocks.

Licence

MIT

# Functions

New instance of API.
NewWithConfig instance of API.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ConfigurationPrefix is the prefix for the configuration keys.
ErrMissingConfig is the error returned when a config key is missing.

# Structs

Config support to the server.
No description provided by the author
Healthcheck model to describe the response http of the healthcheck endpoint.
SSL specification app.

# Interfaces

API wrap the echo framwork Provides a simple way to create a new API Featuring wiht healthcheck and swagger endpoints.