apisix

Documentation

Overview

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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 Cors
  • func BuildCors(enable bool, originStr, headerStr, methodStr *string, maxAge *int64) *Cors
• type Event
• type IpRestriction
  • func BuildIpRestriction(whites, blacks *string) *IpRestriction
• type Match
• type Routex
  • func BuildRoutex(enable bool, rules []Rule) *Routex
• type Rule
• type Token
  • func BuildToken(enable bool, ignoreUris []string) *Token

Types

type Cors

type Cors struct {
	Origins []string `json:"origins,omitempty"`
	Headers []string `json:"headers,omitempty"`
	Methods []string `json:"methods,omitempty"`
	MaxAge  int64    `json:"max_age,omitempty"`
}

Cors

func BuildCors

func BuildCors(enable bool, originStr, headerStr, methodStr *string, maxAge *int64) *Cors

BuildCors

type Event

type Event struct {
	Method string               // ADD UPDATE DELETE
	Kind   string               // route service upstream
	Func   func(...interface{}) // callback
}

type IpRestriction

type IpRestriction struct {
	Whitelist []string `json:"whitelist,omitempty"`
	Blacklist []string `json:"blacklist,omitempty"`
}

ip-restrictio

func BuildIpRestriction

func BuildIpRestriction(whites, blacks *string) *IpRestriction

Convert2IpRestriction build IpRestriction

type Match

type Match struct {
	Host   string   `json:"host,omitempty"`
	Uri    string   `json:"uri,omitempty"`
	Use    string   `json:"use"`
	Key    string   `json:"key"`
	Values []string `json:"values,omitempty"`
}

type Routex

type Routex struct {
	Rules []Rule `json:"rules,inline"`
}

routex

func BuildRoutex

func BuildRoutex(enable bool, rules []Rule) *Routex

BuildRoutex

type Rule

type Rule struct {
	Priority int64   `json:"priority,omitempty"`
	Upstream string  `json:"upstream"`
	Desc     string  `json:"desc"`
	Matches  []Match `json:"matchs,omitempty"`
}

type Token

type Token struct {
	IgnoreUri []string `json:"ignore_uri,omitempty"`
}

token

func BuildToken

func BuildToken(enable bool, ignoreUris []string) *Token

BuildToken