api

Documentation

Index

• func ScanHandler(c *gin.Context)
• type Dictionary
  • func (a *Dictionary) Create(c *gin.Context)
  • func (a *Dictionary) Delete(c *gin.Context)
  • func (a *Dictionary) Get(c *gin.Context)
  • func (a *Dictionary) Query(c *gin.Context)
  • func (a *Dictionary) Update(c *gin.Context)
• type Logger
  • func (a *Logger) Query(c *gin.Context)

Functions

func ScanHandler

func ScanHandler(c *gin.Context)

ScanHandler handles the port scan requests.

Types

type Dictionary

type Dictionary struct {
	DictionaryBIZ *biz.Dictionary
}

Dictionaries management

func (*Dictionary) Create

func (a *Dictionary) Create(c *gin.Context)

@Tags DictionaryAPI @Security ApiKeyAuth @Summary Create dictionary record @Param body body schema.DictionaryForm true "Request body" @Success 200 {object} util.ResponseResult{data=schema.Dictionary} @Failure 400 {object} util.ResponseResult @Failure 401 {object} util.ResponseResult @Failure 500 {object} util.ResponseResult @Router /api/v1/sys/dictionaries [post]

func (*Dictionary) Delete

func (a *Dictionary) Delete(c *gin.Context)

@Tags DictionaryAPI @Security ApiKeyAuth @Summary Delete dictionary record by ID @Param id path string true "unique id" @Success 200 {object} util.ResponseResult @Failure 401 {object} util.ResponseResult @Failure 500 {object} util.ResponseResult @Router /api/v1/sys/dictionaries/{id} [delete]

func (*Dictionary) Get

func (a *Dictionary) Get(c *gin.Context)

@Tags DictionaryAPI @Security ApiKeyAuth @Summary Get dictionary record by ID @Param id path string true "unique id" @Success 200 {object} util.ResponseResult{data=schema.Dictionary} @Failure 401 {object} util.ResponseResult @Failure 500 {object} util.ResponseResult @Router /api/v1/sys/dictionaries/{id} [get]

func (*Dictionary) Query

func (a *Dictionary) Query(c *gin.Context)

@Tags DictionaryAPI @Security ApiKeyAuth @Summary Query dictionary list @Param current query int true "pagination index" default(1) @Param pageSize query int true "pagination size" default(10) @Success 200 {object} util.ResponseResult{data=[]schema.Dictionary} @Failure 401 {object} util.ResponseResult @Failure 500 {object} util.ResponseResult @Router /api/v1/sys/dictionaries [get]

func (*Dictionary) Update

func (a *Dictionary) Update(c *gin.Context)

@Tags DictionaryAPI @Security ApiKeyAuth @Summary Update dictionary record by ID @Param id path string true "unique id" @Param body body schema.DictionaryForm true "Request body" @Success 200 {object} util.ResponseResult @Failure 400 {object} util.ResponseResult @Failure 401 {object} util.ResponseResult @Failure 500 {object} util.ResponseResult @Router /api/v1/sys/dictionaries/{id} [put]

type Logger

type Logger struct {
	LoggerBIZ *biz.Logger
}

Logger management

func (*Logger) Query

func (a *Logger) Query(c *gin.Context)

@Tags LoggerAPI @Security ApiKeyAuth @Summary Query logger list @Param current query int true "pagination index" default(1) @Param pageSize query int true "pagination size" default(10) @Param level query string false "log level" @Param traceID query string false "trace ID" @Param userName query string false "user name" @Param tag query string false "log tag" @Param message query string false "log message" @Param startTime query string false "start time" @Param endTime query string false "end time" @Success 200 {object} util.ResponseResult{data=[]schema.Logger} @Failure 401 {object} util.ResponseResult @Failure 500 {object} util.ResponseResult @Router /api/v1/loggers [get]