beego

package module
v2.0.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 12, 2023 License: Apache-2.0 Imports: 0 Imported by: 0

README

Beego Test Go Report Card Go Reference

Beego is used for rapid development of enterprise application in Go, including RESTful APIs, web apps and backend services.

It is inspired by Tornado, Sinatra and Flask. beego has some Go-specific features such as interfaces and struct embedding.

architecture

Beego is composed of four parts:

  1. Base modules: including log module, config module, governor module;
  2. Task: is used for running timed tasks or periodic tasks;
  3. Client: including ORM module, httplib module, cache module;
  4. Server: including web module. We will support gRPC in the future;

Please use RELEASE version, or master branch which contains the latest bug fix

Quick Start

Old Doc - github New Doc Website Example

Kindly remind that sometimes the HTTPS certificate is expired, you may get some NOT SECURE warning

Web Application

Http Request

Create hello directory, cd hello directory
mkdir hello
cd hello
Init module
go mod init
Download and install
go get github.com/beego/beego/v2@latest
Create file hello.go
package main

import "github.com/beego/beego/v2/server/web"

func main() {
	web.Run()
}
Build and run
go build hello.go
./hello
Go to http://localhost:8080

Congratulations! You've just built your first beego app.

Features

Modules

Community

License

beego source code is licensed under the Apache Licence, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0.html).

Documentation

Index

Constants

View Source 
const (
	// VERSION represent beego web framework version.
	VERSION = "2.0.0"
)

Variables

View Source 
var (
	BuildVersion     string
	BuildGitRevision string
	BuildStatus      string
	BuildTag         string
	BuildTime        string

	GoVersion string

	GitBranch string
)

Functions

This section is empty.

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
Package adapter used to keep compatible with v1.x
 Package adapter used to keep compatible with v1.x
cache
Package cache provide a Cache interface and some implement engine Usage:
 Package cache provide a Cache interface and some implement engine Usage:
cache/memcache
Package memcache for cache provider
 Package memcache for cache provider
cache/redis
Package redis for cache provider
 Package redis for cache provider
cache/ssdb
config
Package config is used to parse config.
 Package config is used to parse config.
config/env
Package env is used to parse environment.
 Package env is used to parse environment.
config/xml
Package xml for config provider.
 Package xml for config provider.
config/yaml
Package yaml for config provider
 Package yaml for config provider
context
Package context provide the context utils Usage:
 Package context provide the context utils Usage:
context/param
grace
Package grace use to hot reload Description: http://grisha.org/blog/2014/06/03/graceful-restart-in-golang/
 Package grace use to hot reload Description: http://grisha.org/blog/2014/06/03/graceful-restart-in-golang/
httplib
Package httplib is used as http.Client Usage:
 Package httplib is used as http.Client Usage:
logs
Package logs provide a general log interface Usage:
 Package logs provide a general log interface Usage:
logs/alils
logs/es
metric
migration
Package migration enables you to generate migrations back and forth.
 Package migration enables you to generate migrations back and forth.
orm
Package orm provide ORM for MySQL/PostgreSQL/sqlite Simple Usage
 Package orm provide ORM for MySQL/PostgreSQL/sqlite Simple Usage
plugins/apiauth
Package apiauth provides handlers to enable apiauth support.
 Package apiauth provides handlers to enable apiauth support.
plugins/auth
Package auth provides handlers to enable basic auth support.
 Package auth provides handlers to enable basic auth support.
plugins/authz
Package authz provides handlers to enable ACL, RBAC, ABAC authorization support.
 Package authz provides handlers to enable ACL, RBAC, ABAC authorization support.
plugins/cors
Package cors provides handlers to enable CORS support.
 Package cors provides handlers to enable CORS support.
session
Package session provider
 Package session provider
session/couchbase
Package couchbase for session provider
 Package couchbase for session provider
session/ledis
Package ledis provide session Provider
 Package ledis provide session Provider
session/memcache
Package memcache for session provider
 Package memcache for session provider
session/mysql
Package mysql for session provider
 Package mysql for session provider
session/postgres
Package postgres for session provider
 Package postgres for session provider
session/redis
Package redis for session provider
 Package redis for session provider
session/redis_cluster
Package redis for session provider
 Package redis for session provider
session/redis_sentinel
Package redis for session provider
 Package redis for session provider
session/ssdb
swagger
Package swagger struct definition
 Package swagger struct definition
testing
toolbox
Package toolbox healthcheck
 Package toolbox healthcheck
utils
utils/captcha
Package captcha implements generation and verification of image CAPTCHAs.
 Package captcha implements generation and verification of image CAPTCHAs.
utils/pagination
Package pagination provides utilities to setup a paginator within the context of a http request.
 Package pagination provides utilities to setup a paginator within the context of a http request.
validation
Package validation for validations
 Package validation for validations
client
cache
Package cache provide a Cache interface and some implement engine Usage:
 Package cache provide a Cache interface and some implement engine Usage:
cache/memcache
Package memcache for cache provider
 Package memcache for cache provider
cache/redis
Package redis for cache provider
 Package redis for cache provider
cache/ssdb
httplib
Package httplib is used as http.Client Usage:
 Package httplib is used as http.Client Usage:
httplib/filter/log
httplib/filter/opentelemetry
httplib/filter/opentracing
httplib/filter/prometheus
httplib/mock
httplib/testing
orm
Package orm provide ORM for MySQL/PostgreSQL/sqlite Simple Usage
 Package orm provide ORM for MySQL/PostgreSQL/sqlite Simple Usage
orm/clauses
orm/clauses/order_clause
orm/filter/bean
orm/filter/opentelemetry
orm/filter/opentracing
orm/filter/prometheus
orm/hints
orm/migration
Package migration enables you to generate migrations back and forth.
 Package migration enables you to generate migrations back and forth.
orm/mock
core
admin
Package admin healthcheck
 Package admin healthcheck
bean
Package bean is a basic package it should not depend on other modules except common module, log module and config module
 Package bean is a basic package it should not depend on other modules except common module, log module and config module
berror
config
Package config is used to parse config.
 Package config is used to parse config.
config/env
Package env is used to parse environment.
 Package env is used to parse environment.
config/etcd
config/json
config/toml
config/xml
Package xml for config provider.
 Package xml for config provider.
config/yaml
Package yaml for config provider Usage:
 Package yaml for config provider Usage:
logs
Package logs provide a general log interface Usage:
 Package logs provide a general log interface Usage:
logs/alils
Package alils implements the SDK(v0.5.0) of Simple Log Service(abbr.
 Package alils implements the SDK(v0.5.0) of Simple Log Service(abbr.
logs/es
utils
utils/pagination
Package pagination provides utilities to setup a paginator within the context of a http request.
 Package pagination provides utilities to setup a paginator within the context of a http request.
validation
Package validation for validations
 Package validation for validations
server
web
Package beego provide a MVC framework beego: an open-source, high-performance, modular, full-stack web framework
 Package beego provide a MVC framework beego: an open-source, high-performance, modular, full-stack web framework
web/captcha
Package captcha implements generation and verification of image CAPTCHAs.
 Package captcha implements generation and verification of image CAPTCHAs.
web/context
Package context provide the context utils Usage:
 Package context provide the context utils Usage:
web/context/param
web/filter/apiauth
Package apiauth provides handlers to enable apiauth support.
 Package apiauth provides handlers to enable apiauth support.
web/filter/auth
Package auth provides handlers to enable basic auth support.
 Package auth provides handlers to enable basic auth support.
web/filter/authz
Package authz provides handlers to enable ACL, RBAC, ABAC authorization support.
 Package authz provides handlers to enable ACL, RBAC, ABAC authorization support.
web/filter/cors
Package cors provides handlers to enable CORS support.
 Package cors provides handlers to enable CORS support.
web/filter/opentracing
web/filter/prometheus
web/filter/ratelimit
web/filter/session
web/grace
Package grace use to hot reload Description: http://grisha.org/blog/2014/06/03/graceful-restart-in-golang/
 Package grace use to hot reload Description: http://grisha.org/blog/2014/06/03/graceful-restart-in-golang/
web/mock
web/pagination
web/session
Package session provider
 Package session provider
web/session/couchbase
Package couchbase for session provider
 Package couchbase for session provider
web/session/ledis
Package ledis provide session Provider
 Package ledis provide session Provider
web/session/memcache
Package memcache for session provider
 Package memcache for session provider
web/session/mysql
Package mysql for session provider
 Package mysql for session provider
web/session/postgres
Package postgres for session provider
 Package postgres for session provider
web/session/redis
Package redis for session provider
 Package redis for session provider
web/session/redis_cluster
Package redis for session provider
 Package redis for session provider
web/session/redis_sentinel
Package redis for session provider
 Package redis for session provider
web/session/ssdb
web/swagger
Package swagger struct definition
 Package swagger struct definition

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.