reference

Documentation

Overview

Copyright (C) 2016-2017 dapperdox.com

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Index

• func APIHandler(specification *spec.APISpecification, api spec.APIGroup) func(w http.ResponseWriter, req *http.Request)
• func GlobalResourceHandler(specification *spec.APISpecification, path string) func(w http.ResponseWriter, req *http.Request)
• func MethodHandler(specification *spec.APISpecification, api spec.APIGroup, path string) func(w http.ResponseWriter, req *http.Request)
• func Register(r *pat.Router)

Functions

func APIHandler

func APIHandler(specification *spec.APISpecification, api spec.APIGroup) func(w http.ResponseWriter, req *http.Request)

------------------------------------------------------------------------------------------------------------ APIHandler is a http.Handler for rendering API reference docs

func GlobalResourceHandler

func GlobalResourceHandler(specification *spec.APISpecification, path string) func(w http.ResponseWriter, req *http.Request)

------------------------------------------------------------------------------------------------------------ ResourceHandler is a http.Handler for rendering API resource reference docs

func MethodHandler

func MethodHandler(specification *spec.APISpecification, api spec.APIGroup, path string) func(w http.ResponseWriter, req *http.Request)

------------------------------------------------------------------------------------------------------------ MethodHandler is a http.Handler for rendering API method reference docs

func Register

func Register(r *pat.Router)

Register creates routes for specification resource