api

Documentation

Overview

Package api provides the common resources for go chi API handlers and routers for the State Server API, namely error responses and RFC 7946 GeoJSON schema structs for serializing and deserializing JSON

Index

• func BadRequestError(err error) render.Renderer
• func InternalServerError(err error) render.Renderer
• func NotFoundError(err error) render.Renderer
• type ErrorResponse
  • func (e *ErrorResponse) Render(w http.ResponseWriter, r *http.Request) error
• type Feature
  • func (sr Feature) Render(w http.ResponseWriter, r *http.Request) error
• type FeatureCollection
  • func (scr FeatureCollection) Render(w http.ResponseWriter, r *http.Request) error
• type Geometry
• type Properties

Functions

func BadRequestError

func BadRequestError(err error) render.Renderer

creates the go-chi renderer for HTTP 400 responses

func InternalServerError

func InternalServerError(err error) render.Renderer

creates the go-chi renderer for HTTP 500 responses

func NotFoundError

func NotFoundError(err error) render.Renderer

creates the go-chi renderer for HTTP 404 responses

Types

type ErrorResponse

type ErrorResponse struct {
	Err            error  `json:"-"`
	StatusText     string `json:"status"`
	ErrorText      string `json:"error,omitempty"`
	HTTPStatusCode int    `json:"-"`
}

Schema for any non-200 HTTP response

func (*ErrorResponse) Render

func (e *ErrorResponse) Render(w http.ResponseWriter, r *http.Request) error

render method which hooks into the go-chi renderer and ensures the correct HTTP response status code is writtern to the response

type Feature

type Feature struct {
	Type       string     `json:"type"`
	Properties Properties `json:"properties"`
	Geometry   Geometry   `json:"geometry"`
}

GeoJSON schema for a feature object

func (Feature) Render

func (sr Feature) Render(w http.ResponseWriter, r *http.Request) error

render method which hooks into the go-chi renderer

type FeatureCollection

type FeatureCollection struct {
	Type     string    `json:"type"`
	Features []Feature `json:"features"`
}

GeoJSON schema for a FeatureCollection object to represent a collection of several states

func (FeatureCollection) Render

func (scr FeatureCollection) Render(w http.ResponseWriter, r *http.Request) error

type Geometry

type Geometry struct {
	Type        string                    `json:"type"`
	Coordinates [][]geospatial.Coordinate `json:"coordinates"`
}

GeoJSON schema for the geometry object of a feature

type Properties

type Properties struct {
	State string `json:"state"`
}

GeoJSON schema for the properties object of a feature