router

Documentation

Overview

Copyright 2016 The GoStor Authors All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Route
  • func NewDeleteRoute(path string, handler httputils.APIFunc) Route
  • func NewGetRoute(path string, handler httputils.APIFunc) Route
  • func NewPostRoute(path string, handler httputils.APIFunc) Route
  • func NewRoute(method, path string, handler httputils.APIFunc) Route
• type Router

Types

type Route

type Route interface {
	// Handler returns the raw function to create the http handler.
	Handler() httputils.APIFunc
	// Method returns the http method that the route responds to.
	Method() string
	// Path returns the subpath where the route responds to.
	Path() string
}

Route defines an individual API route in the docker server.

func NewDeleteRoute

func NewDeleteRoute(path string, handler httputils.APIFunc) Route

NewPostRoute initializes a new route with the http method POST.

func NewGetRoute

func NewGetRoute(path string, handler httputils.APIFunc) Route

NewGetRoute initializes a new route with the http method GET.

func NewPostRoute

func NewPostRoute(path string, handler httputils.APIFunc) Route

NewPostRoute initializes a new route with the http method POST.

func NewRoute

func NewRoute(method, path string, handler httputils.APIFunc) Route

NewRoute initializes a new local router for the reouter

type Router

type Router interface {
	Routes() []Route
}

Router defines an interface to specify a group of routes to add the the docker server.