api_doc

Documentation

Index

• type Doc
• type DocCommit
• type DocLoader
  • func NewDocLoader(content string) (*DocLoader, error)
  • func (d *DocLoader) APICount() int64
  • func (d *DocLoader) AddPrefixInAll(prefix string) error
  • func (d *DocLoader) Marshal() ([]byte, error)
  • func (d *DocLoader) Valid() error
• type IAPIDocService
• type UpdateDoc

Types

type Doc

type Doc struct {
	Id       string
	Service  string
	Content  string
	Updater  string
	UpdateAt time.Time
}

type DocCommit

type DocCommit struct {
	Content  string `json:"content"`
	APICount int64  `json:"api_count"`
}

type DocLoader

type DocLoader struct {
	// contains filtered or unexported fields
}

func NewDocLoader

func NewDocLoader(content string) (*DocLoader, error)

func (*DocLoader) APICount

func (d *DocLoader) APICount() int64

func (*DocLoader) AddPrefixInAll

func (d *DocLoader) AddPrefixInAll(prefix string) error

func (*DocLoader) Marshal

func (d *DocLoader) Marshal() ([]byte, error)

func (*DocLoader) Valid

func (d *DocLoader) Valid() error

type IAPIDocService

type IAPIDocService interface {
	// UpdateDoc 更新文档
	UpdateDoc(ctx context.Context, serviceId string, input *UpdateDoc) error
	// GetDoc 获取文档
	GetDoc(ctx context.Context, serviceId string) (*Doc, error)

	CommitDoc(ctx context.Context, serviceId string, data *Doc) error

	APICountByServices(ctx context.Context, serviceIds ...string) (map[string]int64, error)

	GetDocCommit(ctx context.Context, commitId string) (*commit.Commit[DocCommit], error)
	// LatestDocCommit 获取最新文档
	LatestDocCommit(ctx context.Context, serviceId string) (*commit.Commit[DocCommit], error)
	ListLatestDocCommit(ctx context.Context, serviceIds ...string) ([]*commit.Commit[DocCommit], error)
	ListDocCommit(ctx context.Context, commitIds ...string) ([]*commit.Commit[DocCommit], error)
	LatestAPICountByServices(ctx context.Context, serviceIds ...string) (map[string]int64, error)
	LatestAPICountByCommits(ctx context.Context, commitIds ...string) (map[string]int64, error)
}

type UpdateDoc

type UpdateDoc struct {
	ID      string
	Content string
	Prefix  string
}