at

Documentation

Overview

Package at provides annotations for struct

Package at provides annotations for web RestController

Copyright 2018~now John Deng (hi.devops.io@gmail.com).

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 Annotation
• type AnyMapping
• type AutoConfiguration
• type Component
• type ConfigurationProperties
• type ContextAware
• type ContextPath
• type DeleteMapping
• type GetMapping
• type HealthCheckService
• type JwtRestController
• type Method
• type OptionsMapping
• type PatchMapping
• type PostMapping
• type PutMapping
• type Qualifier
• type RequestBody
• type RequestForm
• type RequestMapping
• type RequestParams
• type ResponseBody
• type ResponseData
• type RestController
• type Tag
• type TraceMapping

Types

type Annotation

type Annotation struct {
	Value string `json:"-"`
}

Annotation is the abstract annotation

type AnyMapping

type AnyMapping struct {
	RequestMapping
	Method string `value:"ANY" json:"-"`
}

AnyMapping is the annotation that set the AnyMapping of a controller

type AutoConfiguration

type AutoConfiguration struct {
	Annotation
}

AutoConfiguration is the annotation of auto configuration

type Component

type Component struct {
	Annotation
}

Component is the annotation that the dependency is injected in app init.

type ConfigurationProperties

type ConfigurationProperties struct {
	Annotation
}

ConfigurationProperties is the annotation that annotate configuration properties

type ContextAware

type ContextAware struct {
	Annotation
}

ContextAware is the annotation that it is the ability of a component to be injected when method of Rest Controller is requested.

type Example struct {
  at.ContextAware
  ...
}

type ContextPath

type ContextPath struct {
	Annotation
}

ContextPath is the annotation that set the context path of a controller

type DeleteMapping

type DeleteMapping struct {
	RequestMapping
	Method string `value:"DELETE" json:"-"`
}

DeleteMapping is the annotation that set the DeleteMapping of a controller

type GetMapping

type GetMapping struct {
	RequestMapping
	Method string `value:"GET" json:"-"`
}

GetMapping is the annotation that set the GetMapping of a controller

type HealthCheckService

type HealthCheckService struct {
	Annotation
}

HealthCheckService is the annotation for health check service

type JwtRestController

type JwtRestController struct {
	Annotation
}

JwtRestController is the annotation that declare current controller is the RESTful Controller with JWT support

type Method

type Method struct {
	Annotation
}

Method is the annotation that set the RequestMethod of a controller

type OptionsMapping

type OptionsMapping struct {
	RequestMapping
	Method string `value:"OPTIONS" json:"-"`
}

OptionsMapping is the annotation that set the OptionsMapping of a controller

type PatchMapping

type PatchMapping struct {
	RequestMapping
	Method string `value:"PATCH" json:"-"`
}

PatchMapping is the annotation that set the PatchMapping of a controller

type PostMapping

type PostMapping struct {
	RequestMapping
	Method string `value:"POST" json:"-"`
}

PostMapping is the annotation that set the PostMapping of a controller

type PutMapping

type PutMapping struct {
	RequestMapping
	Method string `value:"PUT" json:"-"`
}

PutMapping is the annotation that set the PutMapping of a controller

type Qualifier

type Qualifier struct {
	Annotation
}

Qualifier is the annotation that used for disambiguate the references.

type RequestBody

type RequestBody struct {
	Annotation
}

RequestBody the annotation RequestBody

type RequestForm

type RequestForm struct {
	Annotation
}

RequestForm the annotation RequestForm

type RequestMapping

type RequestMapping struct {
	Annotation
}

RequestMapping is the annotation that set the RequestMapping of a controller

type RequestParams

type RequestParams struct {
	Annotation
}

RequestParams the annotation RequestParams

type ResponseBody

type ResponseBody struct {
	Annotation
}

ResponseBody the annotation ResponseBody

type ResponseData

type ResponseData struct {
	Annotation
}

ResponseData the annotation ResponseData

type RestController

type RestController struct {
	Annotation
}

RestController is the annotation that declare current controller is the RESTful Controller

type Tag

type Tag struct {
	Annotation
}

Tag the annotation Tag, tell the injector that the struct implements a tag

type TraceMapping

type TraceMapping struct {
	RequestMapping
	Method string `value:"TRACE" json:"-"`
}

TraceMapping is the annotation that set the TraceMapping of a controller