routes

package

v1.5.0 Latest Latest Go to latest Published: Feb 5, 2024 License: Apache-2.0 Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/axiaoxin-com/pink-lady

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Flatpages(app *gin.Engine)
func GetHostURL(c *gin.Context) string
func InitRouter(httpHandler http.Handler)
func LoadFlatpageFileNames(rootDir string) ([]string, error)
func PageAbout(c *gin.Context)
func PageAwardRecords(c *gin.Context)
func PageHome(c *gin.Context)
func PageMsgBoard(c *gin.Context)
func Ping(c *gin.Context)
func Routes(app *gin.Engine)
type AlertData
- func Alert(c *gin.Context, alert, text string) *AlertData
type MetaData
- func NewMetaData(c *gin.Context, title string) (m *MetaData)
- func (m *MetaData) SetKeywords(c *gin.Context, keywords []string)

Constants ¶

View Source

const (
	// AlertWarningCommon 系统提示通用提示
	AlertInfoCommon = "sys-info"
	// AlertWarningCommon 系统警告通用提示
	AlertWarningCommon = "sys-warning"
	// AlertErrorCommon 系统错误通用提示
	AlertErrorCommon = "sys-error"
	// AlertOK OK
	AlertOK = "ok"
)

View Source

const (
	// AppID common.app id
	AppID = 0

	// SiteName TODO: set your site name
	SiteName = webserver.I18nString("pink-lady")
	Slogan   = webserver.I18nString("")
)

View Source

const (
	// DisableGinSwaggerEnvkey 设置该环境变量时关闭 swagger 文档
	DisableGinSwaggerEnvkey = "DISABLE_GIN_SWAGGER"
)

Variables ¶

View Source

var BuildID = ""

BuildID ..

Functions ¶

func Flatpages ¶ added in v1.5.0

func Flatpages(app *gin.Engine)

func GetHostURL ¶ added in v1.5.0

func GetHostURL(c *gin.Context) string

func InitRouter ¶ added in v1.4.3

func InitRouter(httpHandler http.Handler)

InitRouter 在 gin engine 上注册 url 对应的 HandlerFunc

func LoadFlatpageFileNames ¶ added in v1.5.0

func LoadFlatpageFileNames(rootDir string) ([]string, error)

LoadFlatpageFileNames 加载flatpage文件名称列表（仅加载.md文件）按最后修改时间降序排序

func PageAbout ¶ added in v1.5.0

func PageAbout(c *gin.Context)

func PageAwardRecords ¶ added in v1.5.0

func PageAwardRecords(c *gin.Context)

func PageHome ¶ added in v1.5.0

func PageHome(c *gin.Context)

func PageMsgBoard ¶ added in v1.5.0

func PageMsgBoard(c *gin.Context)

func Ping ¶

func Ping(c *gin.Context)

Ping godoc @Summary 默认的 Ping 接口 @Description 返回 server 相关信息，可以用于健康检查 @Tags x @Accept json @Produce json @Success 200 {object} response.Response @Security ApiKeyAuth @Security BasicAuth @Param trace_id header string false "you can set custom trace id in header" @Router /x/ping [get]

func Routes ¶

func Routes(app *gin.Engine)

Routes 注册 API URL 路由

Types ¶

type AlertData ¶ added in v1.5.0

type AlertData struct {
	Color   string `json:"color"`   // error, warning, info
	Heading string `json:"heading"` // 标题
	Text    string `json:"text"`    // 内容
}

AlertData HTML提示框数据

func Alert ¶ added in v1.5.0

func Alert(c *gin.Context, alert, text string) *AlertData

Alert 页面提示

type MetaData ¶ added in v1.5.0

type MetaData struct {
	SiteName         string
	Slogan           string
	HostURL          string
	BuildID          string
	Env              string
	AppID            int
	AdsenseID        string
	SysNotice        string
	SysNoticeQRText  string
	Title            string
	IsCrawler        bool
	Lang             string
	Keywords         []string
	BaseDesc         string
	BootswatchTheme  string
	I18n             bool
	Beian            string
	AuthorName       string
	AuthorURL        string
	StaticsURL       string
	StaticsSelfhost  bool
	FlatpagesEnable  bool
	FlatpagesNavName string
	FlatpagesNavPath string
	BaiduTongJiID    string
	GtagID           string
	CanonicalURL     template.HTML
	CanonicalLinkTag template.HTML
	ShowAbout        bool
	SinceYear        string
	FriendLinkMap    map[string]string
}

MetaData 元数据

func NewMetaData ¶ added in v1.5.0

func NewMetaData(c *gin.Context, title string) (m *MetaData)

NewMetaData 返回页面元数据

func (*MetaData) SetKeywords ¶ added in v1.5.0

func (m *MetaData) SetKeywords(c *gin.Context, keywords []string)

SetKeywords 设置Keywords字段

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
docs
response Package response 提供统一的 JSON 返回结构，可以通过配置设置具体返回的 code 字段为 int 或者 string	Package response 提供统一的 JSON 返回结构，可以通过配置设置具体返回的 code 字段为 int 或者 string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL