api

package

v0.10.3 Latest Latest Go to latest Published: Feb 1, 2023 License: Apache-2.0 Imports: 20 Imported by: 14

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/yaoapp/gou

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AddGuard(name string, guard gin.HandlerFunc)
func IsAllowed(c *gin.Context, allowsMap map[string]bool) bool
func ProcessGuard(name string) gin.HandlerFunc
func SetGuards(guards map[string]gin.HandlerFunc)
func SetRoutes(router *gin.Engine, path string, allows ...string)
type API
- func Load(file, id string, guard ...string) (*API, error)
- func Select(id string) *API
- func (api *API) Reload() (*API, error)
type HTTP
- func (http HTTP) Route(router gin.IRoutes, path Path, allows ...string)
- func (http HTTP) Routes(router *gin.Engine, path string, allows ...string)
type Out
type Path
type Redirect

Constants ¶

This section is empty.

Variables ¶

View Source

var APIs = map[string]*API{}

APIs 已加载API列表

View Source

var HTTPGuards = map[string]gin.HandlerFunc{}

HTTPGuards 支持的中间件

Functions ¶

func AddGuard ¶

func AddGuard(name string, guard gin.HandlerFunc)

AddGuard add guard

func IsAllowed ¶

func IsAllowed(c *gin.Context, allowsMap map[string]bool) bool

IsAllowed check if the referer is in allow list

func ProcessGuard ¶

func ProcessGuard(name string) gin.HandlerFunc

ProcessGuard guard process

func SetGuards ¶

func SetGuards(guards map[string]gin.HandlerFunc)

SetGuards set guards

func SetRoutes ¶

func SetRoutes(router *gin.Engine, path string, allows ...string)

SetRoutes set the api routes

Types ¶

type API ¶

type API struct {
	ID   string `jsong:"id"`
	Name string
	File string
	Type string
	HTTP HTTP
}

API 数据接口

func Load ¶

func Load(file, id string, guard ...string) (*API, error)

Load load the api

func Select ¶

func Select(id string) *API

Select select api

func (*API) Reload ¶

func (api *API) Reload() (*API, error)

Reload API

type HTTP ¶

type HTTP struct {
	Name        string `json:"name"`
	Version     string `json:"version"`
	Description string `json:"description,omitempty"`
	Group       string `json:"group,omitempty"`
	Guard       string `json:"guard,omitempty"`
	Paths       []Path `json:"paths,omitempty"`
}

HTTP http 协议服务

func (HTTP) Route ¶

func (http HTTP) Route(router gin.IRoutes, path Path, allows ...string)

Route 路径配置转换为路由

func (HTTP) Routes ¶

func (http HTTP) Routes(router *gin.Engine, path string, allows ...string)

Routes 配置转换为路由

type Out ¶

type Out struct {
	Status   int               `json:"status"`
	Type     string            `json:"type,omitempty"`
	Body     interface{}       `json:"body,omitempty"`
	Headers  map[string]string `json:"headers,omitempty"`
	Redirect *Redirect         `json:"redirect,omitempty"`
}

Out http 输出

type Path ¶

type Path struct {
	Label       string        `json:"label,omitempty"`
	Description string        `json:"description,omitempty"`
	Path        string        `json:"path"`
	Method      string        `json:"method"`
	Process     string        `json:"process"`
	Guard       string        `json:"guard,omitempty"`
	In          []interface{} `json:"in,omitempty"`
	Out         Out           `json:"out,omitempty"`
}

Path HTTP Path

type Redirect ¶

type Redirect struct {
	Code     int    `json:"code,omitempty"`
	Location string `json:"location,omitempty"`
}

Redirect out redirect

Source Files ¶

View all Source files

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