example

Documentation

Index

• type ApiGroup
• type CustomerApi
  • func (e *CustomerApi) CreateExaCustomer(c *gin.Context)
  • func (e *CustomerApi) DeleteExaCustomer(c *gin.Context)
  • func (e *CustomerApi) GetExaCustomer(c *gin.Context)
  • func (e *CustomerApi) GetExaCustomerList(c *gin.Context)
  • func (e *CustomerApi) UpdateExaCustomer(c *gin.Context)
• type ExcelApi
  • func (e *ExcelApi) DownloadTemplate(c *gin.Context)
  • func (e *ExcelApi) ExportExcel(c *gin.Context)
  • func (e *ExcelApi) ImportExcel(c *gin.Context)
  • func (e *ExcelApi) LoadExcel(c *gin.Context)
• type FileUploadAndDownloadApi
  • func (u *FileUploadAndDownloadApi) BreakpointContinue(c *gin.Context)
  • func (b *FileUploadAndDownloadApi) BreakpointContinueFinish(c *gin.Context)
  • func (u *FileUploadAndDownloadApi) DeleteFile(c *gin.Context)
  • func (u *FileUploadAndDownloadApi) FindFile(c *gin.Context)
  • func (u *FileUploadAndDownloadApi) GetFileList(c *gin.Context)
  • func (u *FileUploadAndDownloadApi) RemoveChunk(c *gin.Context)
  • func (u *FileUploadAndDownloadApi) UploadFile(c *gin.Context)

Types

type ApiGroup

type ApiGroup struct {
	ExcelApi
	CustomerApi
	FileUploadAndDownloadApi
}

type CustomerApi

type CustomerApi struct{}

func (*CustomerApi) CreateExaCustomer

func (e *CustomerApi) CreateExaCustomer(c *gin.Context)

@Tags ExaCustomer @Summary 创建客户 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body example.ExaCustomer true "客户用户名, 客户手机号码" @Success 200 {object} response.Response{msg=string} "创建客户" @Router /customer/customer [post]

func (*CustomerApi) DeleteExaCustomer

func (e *CustomerApi) DeleteExaCustomer(c *gin.Context)

@Tags ExaCustomer @Summary 删除客户 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body example.ExaCustomer true "客户ID" @Success 200 {object} response.Response{msg=string} "删除客户" @Router /customer/customer [delete]

func (*CustomerApi) GetExaCustomer

func (e *CustomerApi) GetExaCustomer(c *gin.Context)

@Tags ExaCustomer @Summary 获取单一客户信息 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data query example.ExaCustomer true "客户ID" @Success 200 {object} response.Response{data=exampleRes.ExaCustomerResponse,msg=string} "获取单一客户信息,返回包括客户详情" @Router /customer/customer [get]

func (*CustomerApi) GetExaCustomerList

func (e *CustomerApi) GetExaCustomerList(c *gin.Context)

@Tags ExaCustomer @Summary 分页获取权限客户列表 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data query request.PageInfo true "页码, 每页大小" @Success 200 {object} response.Response{data=response.PageResult,msg=string} "分页获取权限客户列表,返回包括列表,总数,页码,每页数量" @Router /customer/customerList [get]

func (*CustomerApi) UpdateExaCustomer

func (e *CustomerApi) UpdateExaCustomer(c *gin.Context)

@Tags ExaCustomer @Summary 更新客户信息 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body example.ExaCustomer true "客户ID, 客户信息" @Success 200 {object} response.Response{msg=string} "更新客户信息" @Router /customer/customer [put]

type ExcelApi

type ExcelApi struct{}

func (*ExcelApi) DownloadTemplate

func (e *ExcelApi) DownloadTemplate(c *gin.Context)

@Tags excel @Summary 下载模板 @Security ApiKeyAuth @accept multipart/form-data @Produce application/json @Param fileName query string true "模板名称" @Success 200 @Router /excel/downloadTemplate [get]

func (*ExcelApi) ExportExcel

func (e *ExcelApi) ExportExcel(c *gin.Context)

@Tags excel @Summary 导出Excel @Security ApiKeyAuth @accept application/json @Produce application/octet-stream @Param data body example.ExcelInfo true "导出Excel文件信息" @Success 200 @Router /excel/exportExcel [post]

func (*ExcelApi) ImportExcel

func (e *ExcelApi) ImportExcel(c *gin.Context)

@Tags excel @Summary 导入Excel文件 @Security ApiKeyAuth @accept multipart/form-data @Produce application/json @Param file formData file true "导入Excel文件" @Success 200 {object} response.Response{msg=string} "导入Excel文件" @Router /excel/importExcel [post]

func (*ExcelApi) LoadExcel

func (e *ExcelApi) LoadExcel(c *gin.Context)

@Tags excel @Summary 加载Excel数据 @Security ApiKeyAuth @Produce application/json @Success 200 {object} response.Response{data=response.PageResult,msg=string} "加载Excel数据,返回包括列表,总数,页码,每页数量" @Router /excel/loadExcel [get]

type FileUploadAndDownloadApi

type FileUploadAndDownloadApi struct{}

func (*FileUploadAndDownloadApi) BreakpointContinue

func (u *FileUploadAndDownloadApi) BreakpointContinue(c *gin.Context)

@Tags ExaFileUploadAndDownload @Summary 断点续传到服务器 @Security ApiKeyAuth @accept multipart/form-data @Produce application/json @Param file formData file true "an example for breakpoint resume, 断点续传示例" @Success 200 {object} response.Response{msg=string} "断点续传到服务器" @Router /fileUploadAndDownload/breakpointContinue [post]

func (*FileUploadAndDownloadApi) BreakpointContinueFinish

func (b *FileUploadAndDownloadApi) BreakpointContinueFinish(c *gin.Context)

@Tags ExaFileUploadAndDownload @Summary 创建文件 @Security ApiKeyAuth @accept multipart/form-data @Produce application/json @Param file formData file true "上传文件完成" @Success 200 {object} response.Response{data=exampleRes.FilePathResponse,msg=string} "创建文件,返回包括文件路径" @Router /fileUploadAndDownload/findFile [post]

func (*FileUploadAndDownloadApi) DeleteFile

func (u *FileUploadAndDownloadApi) DeleteFile(c *gin.Context)

@Tags ExaFileUploadAndDownload @Summary 删除文件 @Security ApiKeyAuth @Produce application/json @Param data body example.ExaFileUploadAndDownload true "传入文件里面id即可" @Success 200 {object} response.Response{msg=string} "删除文件" @Router /fileUploadAndDownload/deleteFile [post]

func (*FileUploadAndDownloadApi) FindFile

func (u *FileUploadAndDownloadApi) FindFile(c *gin.Context)

@Tags ExaFileUploadAndDownload @Summary 查找文件 @Security ApiKeyAuth @accept multipart/form-data @Produce application/json @Param file formData file true "Find the file, 查找文件" @Success 200 {object} response.Response{data=exampleRes.FileResponse,msg=string} "查找文件,返回包括文件详情" @Router /fileUploadAndDownload/findFile [post]

func (*FileUploadAndDownloadApi) GetFileList

func (u *FileUploadAndDownloadApi) GetFileList(c *gin.Context)

@Tags ExaFileUploadAndDownload @Summary 分页文件列表 @Security ApiKeyAuth @accept application/json @Produce application/json @Param data body request.PageInfo true "页码, 每页大小" @Success 200 {object} response.Response{data=response.PageResult,msg=string} "分页文件列表,返回包括列表,总数,页码,每页数量" @Router /fileUploadAndDownload/getFileList [post]

func (*FileUploadAndDownloadApi) RemoveChunk

func (u *FileUploadAndDownloadApi) RemoveChunk(c *gin.Context)

@Tags ExaFileUploadAndDownload @Summary 删除切片 @Security ApiKeyAuth @accept multipart/form-data @Produce application/json @Param file formData file true "删除缓存切片" @Success 200 {object} response.Response{msg=string} "删除切片" @Router /fileUploadAndDownload/removeChunk [post]

func (*FileUploadAndDownloadApi) UploadFile

func (u *FileUploadAndDownloadApi) UploadFile(c *gin.Context)

@Tags ExaFileUploadAndDownload @Summary 上传文件示例 @Security ApiKeyAuth @accept multipart/form-data @Produce application/json @Param file formData file true "上传文件示例" @Success 200 {object} response.Response{data=exampleRes.ExaFileResponse,msg=string} "上传文件示例,返回包括文件详情" @Router /fileUploadAndDownload/upload [post]