genapi

Documentation

Index

• func WriteMarkdown(w io.Writer, pkg *Package, options ...Option) error
• type Constant
• type Field
• type Option
  • func WithGroupVersion(gv schema.GroupVersion) Option
  • func WithScheme(scheme *runtime.Scheme) Option
• type Package
  • func ParsePackage(path string) (*Package, error)
• type Struct
• type Value

Functions

func WriteMarkdown

func WriteMarkdown(w io.Writer, pkg *Package, options ...Option) error

WriteMarkdown writes the API of pkg as markdown to w.

Types

type Constant

type Constant struct {
	Name   string
	Doc    string
	Values []Value
}

A Constant represents a constant.

type Field

type Field struct {
	Name     string
	Doc      string
	Type     types.Type
	Required bool
}

A Field represents a struct field.

type Option

type Option interface {
	// contains filtered or unexported methods
}

An Option applies an option.

func WithGroupVersion

func WithGroupVersion(gv schema.GroupVersion) Option

WithGroupVersion returns an option that sets the GroupVersion.

func WithScheme

func WithScheme(scheme *runtime.Scheme) Option

WithScheme returns an option that sets the scheme.

type Package

type Package struct {
	Pkg     *packages.Package
	AstPkg  *ast.Package
	DocPkg  *doc.Package
	FileSet *token.FileSet

	Constants map[string]Constant
	Structs   map[string]Struct
}

A Package represents a package.

func ParsePackage

func ParsePackage(path string) (*Package, error)

ParsePackage parses the package in the given path.

type Struct

type Struct struct {
	Name   string
	Doc    string
	Type   types.Type
	Fields []Field
}

A Struct represents a struct.

type Value

type Value struct {
	Doc   string
	Name  string
	Value constant.Value
}

A Value represents a constant value.