fnc

fnc

fns generators

Install

go install github.com/aacfactory/fnc@v1.2.0

Usage

Use Command

fnc -p ./path_of_fns_project

Use Go Generate

// main
// go:generate fnc -p .
func main() {
	
}

Markup Service Doc
doc.go in fn source file's folder.

// Package samples
// @service samples
// @title samples
// @description samples service
// @internal false
package samples

Makeup Fn Doc

// query
// @fn query
// @validate true
// @authorization true
// @permission false
// @title query
// @description query
func query(ctx fns.Context, param QueryParam) (v []*Sample, err errors.CodeError) {

	return
}

Makeup Struct Doc

// QueryParam
// @title title 
// @description description
type QueryParam struct {
	// Offset
	// @title title 
	// @description description
	Offset int `json:"offset" validate:"required" message:"offset is invalid"`
	// Limit
	// @title title 
	// @description description
	Limit  int `json:"limit" validate:"required" message:"limit is invalid"`
}

// Sample
// @title title of sample
// @description >>> description of sample
// > support markdown
// 
// <<<
type Sample struct {
	// Id
	// @title 编号
	// @description 编号
	Id string `json:"id"`
	// Mobile
	// @title 手机号
	// @description 手机号
	Mobile string `json:"mobile"`
	// Name
	// @title 姓名
	// @description 姓名
	Name string `json:"name"`
	// Gender
	// @title 性别
	// @enum M,F,N
	// @description 性别
	Gender string `json:"gender"`
	// Age
	// @title 年龄
	// @description 年龄
	// @enum 1,2,3
	Age int `json:"age"`
	// Avatar
	// @title 头像图片地址
	// @description 头像图片地址
	Avatar string `json:"avatar"`
	// Score
	// @title Score
	// @description Score
	Score float32 `json:"score,omitempty"`
	// DOB
	// @title DOB
	// @description DOB
	DOB json.Date `json:"dob,omitempty"`
	// CreateAT
	// @title CreateAT
	// @description CreateAT
	CreateAT json.Time `json:"createAt,omitempty"`
	// Tokens
	// @title Tokens
	// @description Tokens
	Tokens []string
	// Users
	// @title Users
	// @description Users
	Users []*users.User `json:"users,omitempty"`
	// UserMap
	// @title UserMap
	// @description UserMap
	UserMap map[string]*users.User `json:"userMap,omitempty"`
	// Raw
	// @title Raw
	// @description Raw
	Raw json.RawMessage
}

Annotations

• @service

  service namespace
  example: @service foo

• @internal

  an internal service, that all fns in service can not be accessed by public requests. example @internal true

• @fn

  fn address
  example: @fn foo

• @validate

  property validate
  mark property need be validated. example @validate true

• @authorization

  fn needs authorization example: @authorization true

• @permission

  fn has permission not implement

• @tx

  open transaction in fn, and auto commit after succeed action or rollback after failed action. support sql only now. example: @tx sql

• @title

  title

• @description

  description

Note

Type of Fn Argument must be value object.
Builtin, Star Type, Map, Array and Alias Type are not supported.

Type of Fn Result must be star object or array. Builtin, Value Object, Map, Array and Alias Type are not supported.