pick

README

pick

一个基于反射的自动注入api开发框架http api服务器,灵感来自于grpc和springmvc,pick的默认基于gin,如不想使用，pick同时兼容fiber(fasthttp),底层可选择。

feature

• 摆脱路由注册

  摆脱零散的各处的路由注册 xxx.Handle("/"，func(){})

• 摆脱w,r,摆脱xxx.Context

  不再编写这样func(w http.ResponseWriter, r *http.Request)或者func(ctx xxx.Context){ctx.XXX()}的业务代码

• 专注于业务

quick start

go get github.com/hopeio/pick go run _example/gin/main.go

usage

main.go

func main() {
  server := gin.New()
  pickgin.Register(server, &UserService{})
  log.Println("visit http://localhost:8080")
  log.Fatal(server.Run(":8080"))
}

service.go

// 首先我们需要定义一个服务
type UserService struct{}
//需要实现Service方法，返回该服务的说明，url前缀，以及需要的中间件
func (*UserService) Service() (string, string, []http.HandlerFunc) {
return "用户相关", "/api/v1/user", []http.HandlerFunc{middleware.Log}
}
// 然后可以写我们的业务方法
func (*UserService) Add(ctx *httpctx.Context, req *model.SignupReq) (*model.User, error) {
//对于一个性能强迫症来说，我宁愿它不优雅一些也不能接受每次都调用
  pick.Api(func() {
  return pick.Post("").
    Title("用户注册").
    CreateLog("1.0.0", "jyb", "2019/12/16", "创建").
    ChangeLog("1.0.1", "jyb", "2019/12/16", "修改测试").
    End()
  })
  return &model.User{Name: "测试"}, nil
}

func (*UserService) Edit(ctx *httpctx.Context, req *model.User) (*model.User, error) {
  pick.Api(func() {
    return pick.Put("/:id").
      Title("用户编辑").
      CreateLog("1.0.0", "jyb", "2019/12/16", "创建").
      Deprecated("1.0.0", "jyb", "2019/12/16", "删除").
      End()
  })
  return nil, nil
}

这会生成如下的Api

 API:	 POST   /api/v1/user   用户注册
 API:	 PUT    /api/v1/user/:id   用户编辑(废弃)

api完整示例

func (*UserService) Add(ctx *ginctx.Context, req *model.SignupReq) (*model.User, error) {
	//对于一个性能强迫症来说，我宁愿它不优雅一些也不能接受每次都调用
	pick.Api(func() {
		return pick.Post("").//定义请求的方法及路由
			Title("用户注册").//接口描述
            Middleware(nil).//中间件
            //接口迭代信息
			CreateLog("1.0.0", "jyb", "2019/12/16", "创建").//创建，唯一
			ChangeLog("1.0.1", "jyb", "2019/12/16", "修改测试").//变更，可有多个
			Deprecated("1.0.0", "jyb", "2019/12/16", "删除").//废弃，唯一
            End()
	})
	return &model.User{Name: "测试"}, nil
}

文档生成

/apidoc pick会为我们生成swagger和markdown文档 当然，这需要你定义的请求配合，例如

type User struct {
	Id uint64 `json:"id"`
	Name string `json:"name" comment:"名字" validate:"gte=3,lte=10"`
	Password string `json:"password" comment:"密码" validate:"gte=8,lte=15"`
	Mail string `json:"mail" comment:"邮箱" validate:"email"`
	Phone string `json:"phone" comment:"手机" validate:"phone"`
}

swagger

markdown

[TOC]

用户相关

---

用户注册-v1(/api/v1/user)

POST /api/v1/user (Principal jyb)

接口记录

版本	操作	时间	负责人	日志
1.0.0	创建	2019/12/16	jyb	创建
1.0.1	变更	2019/12/16	jyb	修改测试

参数信息

字段名称	字段类型	字段描述	校验要求
name	string	名字	长度必须至少为3个字符
password	string	密码	长度必须至少为8个字符
mail	string	邮箱	必须是一个有效的手机号!
请求示例

{
	"name": "耰塧囎飿段",
	"password": "虱鷅磷黽楑",
	"mail": "盬艦潦昊譙"
}  

返回信息

字段名称	字段类型	字段描述
id	number
name	string	名字
password	string	密码
mail	string	邮箱
mail	string	手机
返回示例

{
	"id": 1357,
	"name": "鐷嚅凮珘緻",
	"password": "梊朖迍髽栳"
}  

用户编辑-v1(废弃)(/api/v1/user/:id)

PUT /api/v1/user/:id (Principal jyb)

接口记录

...

是的，示例并不那么好看，并非不能支持简体字和英文字母，我计划单独写一个mock模块

changelog

1. 移除httprouter,默认gin路由

Documentation

Index

• Constants
• Variables
• func Api(f func())
• func CommonHandler(w http.ResponseWriter, req *http.Request, handle *reflect.Value, ps *Params)
• func Connect(p string) *apiInfo
• func Delete(p string) *apiInfo
• func Get(p string) *apiInfo
• func GetMethodInfo(method *reflect.Method, preUrl string, httpContext reflect.Type) (info *apiInfo)
• func HandlerPrefix(p string)
• func Head(p string) *apiInfo
• func Log(method, path, title string)
• func Options(p string) *apiInfo
• func Patch(p string) *apiInfo
• func Post(p string) *apiInfo
• func Put(p string) *apiInfo
• func Registered()
• func ResWriteReflect(w http.ResponseWriter, traceId string, result []reflect.Value)
• func Trace(p string) *apiInfo
• type ApiInfo
  • func (api *ApiInfo) GetPrincipal() string
• type Param
• type Params
• type ParseToHttpResponse
• type Service

Constants

const Template = `` /* 345-byte string literal not displayed */

Variables

var (
	ContextType  = reflect.TypeOf((*context.Context)(nil)).Elem()
	ContextValue = reflect.ValueOf(context.Background())
	ErrorType    = reflect.TypeOf((*error)(nil)).Elem()
)

var (
	HttpContextType = reflect.TypeOf((*httpctx.Context)(nil))
)

Functions

func Api

func Api(f func())

func CommonHandler

func CommonHandler(w http.ResponseWriter, req *http.Request, handle *reflect.Value, ps *Params)

func Connect

func Connect(p string) *apiInfo

func Delete

func Delete(p string) *apiInfo

func Get

func Get(p string) *apiInfo

func GetMethodInfo

func GetMethodInfo(method *reflect.Method, preUrl string, httpContext reflect.Type) (info *apiInfo)

recover捕捉panic info

func HandlerPrefix

func HandlerPrefix(p string)

func Head

func Head(p string) *apiInfo

func Log

func Log(method, path, title string)

func Options

func Options(p string) *apiInfo

func Patch

func Patch(p string) *apiInfo

func Post

func Post(p string) *apiInfo

func Put

func Put(p string) *apiInfo

func Registered

func Registered()

func ResWriteReflect

func ResWriteReflect(w http.ResponseWriter, traceId string, result []reflect.Value)

func Trace

func Trace(p string) *apiInfo

Types

type ApiInfo

type ApiInfo struct {
	Path, Method, Title string
	Version             int
	Changelog           []changelog
	Createlog           changelog
	Deprecated          *changelog
	Middleware          []http.HandlerFunc
}

func (*ApiInfo) GetPrincipal

func (api *ApiInfo) GetPrincipal() string

获取负责人

type Param

type Param struct {
	Key   string
	Value string
}

Param is a single URL parameter, consisting of a key and a value.

type Params

type Params []Param

Params is a Param-slice, as returned by the router. The slice is ordered, the first URL parameter is also the first slice value. It is therefore safe to read values by the index.

type ParseToHttpResponse

type ParseToHttpResponse interface {
	Parse() ([]byte, error)
}

type Service

type Service[T any] interface {
	//返回描述，url的前缀，中间件
	Service() (describe, prefix string, middleware []T)
}