rest

README

BindPlane Rest API

Swagger

The Rest API endpoints are documented with gin-swagger.

---

Generating Documentation:

First make sure you have swag cli installed with make install-tools or install directly with:

go get -u github.com/swaggo/swag/cmd/swag

Generate docs.

make swagger

---

Viewing Documentation:

Run bindplane server

bindplane serve

By default docs will be at localhost:3001/swagger/index.html

Documentation

Index

• func AddDownloadRoutes(router gin.IRouter, bindplane server.BindPlane)
• func AddRestRoutes(router gin.IRouter, bindplane server.BindPlane)
• type ErrorResponse
  • func NewErrorResponse(err error) ErrorResponse

Functions

func AddDownloadRoutes

func AddDownloadRoutes(router gin.IRouter, bindplane server.BindPlane)

AddDownloadRoutes adds /download/* routes to the gin HTTP router

func AddRestRoutes

func AddRestRoutes(router gin.IRouter, bindplane server.BindPlane)

AddRestRoutes adds all API routes to the gin HTTP router

Types

type ErrorResponse

type ErrorResponse struct {
	Errors []string `json:"errors"`
}

ErrorResponse TODO(doc)

func NewErrorResponse

func NewErrorResponse(err error) ErrorResponse

NewErrorResponse returns a new ErrorResponse from a given error.