api

package
v0.0.0-...-e0c21b1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2017 License: MIT Imports: 6 Imported by: 0

README

API Documentation

Navigate inside of the folders of this package to see specific documentation on the various available APIs.

Documentation

Overview

Package api handles all API calls

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func HandleAPI

func HandleAPI(res http.ResponseWriter, req *http.Request, path string, publicServer *public.Controller) (bool, bool)

HandleAPI function takes a path and determines if it is an API call, if it is it will call the specified API. It returns two booleans, the first being if it is an API call and the second is the response of the API call's function.

The path of an API is formatted as such: document_roots/webhost/api/some/thing. The path is split by the sequence of characters "api", returning the first half of the URL which is discarded, and the second half which will look like /some/thing. The second half is processed to see whether or not it is a valid API, and then handled accordingly from there.

Types

This section is empty.

Directories

Path Synopsis
Package logs is a child of package api to handle api calls concerning log files Package logs is a child of package api to handle api calls concerning log files
Package logs is a child of package api to handle api calls concerning log files Package logs is a child of package api to handle api calls concerning log files
Package server is a child of package api to handle api calls concerning the server Package server is a child of package api to handle api calls concerning the server Package server is a child of package api to handle api calls concerning the server Package server is a child of package api to handle api calls concerning the server Package server is a child of package api to handle api calls concerning the server
Package server is a child of package api to handle api calls concerning the server Package server is a child of package api to handle api calls concerning the server Package server is a child of package api to handle api calls concerning the server Package server is a child of package api to handle api calls concerning the server Package server is a child of package api to handle api calls concerning the server
Package user is a child of package api to handle api calls concerning users Package user is a child of package api to handle api calls concerning users Package user is a child of package api to handle api calls concerning users Package user is a child of package api to handle api calls concerning users Package user is a child of package api to handle api calls concerning users
Package user is a child of package api to handle api calls concerning users Package user is a child of package api to handle api calls concerning users Package user is a child of package api to handle api calls concerning users Package user is a child of package api to handle api calls concerning users Package user is a child of package api to handle api calls concerning users

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL