api

Documentation

Overview

Code generated by generator. DO NOT EDIT.

Code generated by generator. DO NOT EDIT.

Index

• func RegisterRouter(router *gin.Engine, svc BlogService)
• type BlogService
• type CategoriesReply
• type CategoriesRequest
• type ChangePassReply
• type ChangePassRequest
• type DeleteCategoryReply
• type DeleteCategoryRequest
• type DeleteNoteReply
• type DeleteNoteRequest
• type LoginReply
• type LoginRequest
• type LogoutReply
• type LogoutRequest
• type NoteReply
• type NoteRequest
• type NotesReply
• type NotesRequest
• type PostCategoryReply
• type PostCategoryRequest
• type PostNoteReply
• type PostNoteRequest
• type SearchNoteReply
• type SearchNoteRequest

Functions

func RegisterRouter

func RegisterRouter(router *gin.Engine, svc BlogService)

RegisterRouter register router

Types

type BlogService

type BlogService interface {
	Ping() error
	Categories(ctx *rest.Context, request *CategoriesRequest) (reply *CategoriesReply, err error)
	PostCategory(ctx *rest.Context, request *PostCategoryRequest) (reply *PostCategoryReply, err error)
	DeleteCategory(ctx *rest.Context, request *DeleteCategoryRequest) (reply *DeleteCategoryReply, err error)
	Note(ctx *rest.Context, request *NoteRequest) (reply *NoteReply, err error)
	Notes(ctx *rest.Context, request *NotesRequest) (reply *NotesReply, err error)
	SearchNote(ctx *rest.Context, request *SearchNoteRequest) (reply *SearchNoteReply, err error)
	PostNote(ctx *rest.Context, request *PostNoteRequest) (reply *PostNoteReply, err error)
	DeleteNote(ctx *rest.Context, request *DeleteNoteRequest) (reply *DeleteNoteReply, err error)
	Logout(ctx *rest.Context, request *LogoutRequest) (reply *LogoutReply, err error)
	Login(ctx *rest.Context, request *LoginRequest) (reply *LoginReply, err error)
	ChangePass(ctx *rest.Context, request *ChangePassRequest) (reply *ChangePassReply, err error)
}

BlogService service define

type CategoriesReply

type CategoriesReply = []model.Category

CategoriesReply get categories reply

type CategoriesRequest

type CategoriesRequest struct {
}

CategoriesRequest get categories @Router /categories [get] @Auth false

type ChangePassReply

type ChangePassReply struct {
	rest.ResultReply
}

ChangePassReply ...

type ChangePassRequest

type ChangePassRequest struct {
	OldPass string `json:"oldPass" binding:"required"`
	NewPass string `json:"newPass" binding:"required"`
}

ChangePassRequest change password request @Router /changePass [post] @Auth true

type DeleteCategoryReply

type DeleteCategoryReply struct {
	rest.ResultReply
}

DeleteCategoryReply delete category reply

type DeleteCategoryRequest

type DeleteCategoryRequest struct {
	ID int `uri:"id" binding:"required"`
}

DeleteCategoryRequest delete category @Router /category/:id [delete] @Auth true

type DeleteNoteReply

type DeleteNoteReply struct {
	rest.ResultReply
}

DeleteNoteReply delete note reply

type DeleteNoteRequest

type DeleteNoteRequest struct {
	ID int `uri:"id" binding:"required"`
}

DeleteNoteRequest delete note request @Router /note/:id [delete] @Auth true

type LoginReply

type LoginReply struct {
	model.User
}

LoginReply login reply

type LoginRequest

type LoginRequest struct {
	Name   string `json:"name" binding:"required"`
	Secret string `json:"secret" binding:"required"`
}

LoginRequest login request @Router /login [post] @Auth false

type LogoutReply

type LogoutReply struct {
	model.User
}

LogoutReply logout reply

type LogoutRequest

type LogoutRequest struct {
	Name   string `json:"name" binding:"required"`
	Secret string `json:"secret" binding:"required"`
}

LogoutRequest logout request @Router /logout [post] @Auth false

type NoteReply

type NoteReply struct {
	*model.NoteDetail
}

NoteReply note reply

type NoteRequest

type NoteRequest struct {
	ID int `uri:"id" binding:"required"`
}

NoteRequest note request @Router /note/:id [get] @Auth false

type NotesReply

type NotesReply struct {
	*rest.ListData
}

NotesReply notes reply

type NotesRequest

type NotesRequest struct {
	rest.PageOption
	ClassifyID int `form:"classifyID"`
}

NotesRequest notes request @Router /notes [get] @Auth false

type PostCategoryReply

type PostCategoryReply struct {
	*model.Category
}

PostCategoryReply post category reply

type PostCategoryRequest

type PostCategoryRequest struct {
	Name   string `json:"name" binding:"required"`
	ID     uint   `json:"id"`
	Parent int    `json:"parent"`
	Order  int    `json:"order"`
}

PostCategoryRequest post category @Router /category [post] @Auth true

type PostNoteReply

type PostNoteReply struct {
	*model.NoteDetail
}

PostNoteReply notes reply

type PostNoteRequest

type PostNoteRequest struct {
	ID         uint     `json:"id"`
	Title      string   `json:"title" binding:"required"`
	Text       string   `json:"text" binding:"required"`
	Labels     []string `json:"labels"`
	CategoryID int      `json:"categoryID"`
	Status     int      `json:"status"`
}

PostNoteRequest post note request @Router /note [post] @Auth true

type SearchNoteReply

type SearchNoteReply struct {
	*rest.ListData
}

SearchNoteReply search note reply

type SearchNoteRequest

type SearchNoteRequest struct {
	rest.PageOption
	ClassifyID int    `form:"classifyID"`
	Key        string `form:"key" binding:"required"`
}

SearchNoteRequest search note request @Router /search [get] @Auth false