rest

Documentation

Index

• Constants
• func GetByCounty(c echo.Context) error
• func GetByCountyCity(c echo.Context) error
• func GetByStateCity(c echo.Context) error
• func GetByStateCounty(c echo.Context) error
• func GetByZipcode(c echo.Context) error
• func NewAPI() (api *echo.Echo)

Constants

const (
	PORT = ":20790"
)

Functions

func GetByCounty

func GetByCounty(c echo.Context) error

@Summary Get Zipcode Information @Description get info by county @ID get-info-by-county @Accept json @Produce json @Param county path string true "County name" @Success 200 {array} models.Zipcode @Router /counties/{county} [get]

func GetByCountyCity

func GetByCountyCity(c echo.Context) error

@Summary Get Zipcode Information @Description get info by county and city @ID get-info-by-county-city @Accept json @Produce json @Param county path string true "County name" @Param city path string true "City name" @Success 200 {array} models.Zipcode @Router /counties/{county}/cities/{city} [get]

func GetByStateCity

func GetByStateCity(c echo.Context) error

@Summary Get Zipcode Information @Description get info by state and city @ID get-info-by-state-city @Accept json @Produce json @Param state path string true "State name" @Param city path string true "City name" @Success 200 {array} models.Zipcode @Router /states/{state}/cities/{city} [get]

func GetByStateCounty

func GetByStateCounty(c echo.Context) error

@Summary Get Zipcode Information @Description get info by state and county @ID get-info-by-state-county @Accept json @Produce json @Param state path string true "State name" @Param county path string true "County name" @Success 200 {array} models.Zipcode @Router /states/{state}/counties/{county} [get]

func GetByZipcode

func GetByZipcode(c echo.Context) error

@Summary Get Zipcode Information @Description get info by zipcode @ID get-info-by-zipcode @Accept json @Produce json @Param zipcode path string true "Zipcode value" @Success 200 {object} models.Zipcode @Router /zipcodes/{zipcode} [get]

func NewAPI

func NewAPI() (api *echo.Echo)