Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.2.0

Aug 14, 2018

Changes in this version

+ const CommentsOptionAlias

+ const CommentsOptionDescriptors

+ const CommentsOptionModifiers

+ const CommentsOptionOrigin

+ const TypeNameInvalid

+ func NewPathDefinitions(tc *TypeContainer, definitions map[string][]definition.Definition) (map[string][]Definition, error)

+ type Analyzer struct

+ func NewAnalyzer(root string) *Analyzer

+ func (a *Analyzer) Comments(pos token.Pos) *ast.CommentGroup

+ func (a *Analyzer) FindPackages(target string) []string

+ func (a *Analyzer) Import(path string) (*types.Package, error)

+ func (a *Analyzer) ObjectOf(pkg, name string) (types.Object, error)

+ func (a *Analyzer) PackageComments(path string) []*ast.CommentGroup

+ func (a *Analyzer) Packages(parent string, vendor bool) []string

+ type Buffer struct

+ func NewBuffer() *Buffer

+ func (b *Buffer) Bytes() []byte

+ func (b *Buffer) String() string

+ func (b *Buffer) Write(a ...interface{})

+ func (b *Buffer) Writef(format string, a ...interface{})

+ func (b *Buffer) Writeln(a ...interface{})

+ type Comments struct

+ func ParseComments(comments string) *Comments

+ func (c *Comments) AddOption(name, value string)

+ func (c *Comments) BlockComments() string

+ func (c *Comments) CleanOptions()

+ func (c *Comments) LineComments() string

+ func (c *Comments) Option(name string) []string

+ func (c *Comments) Options() map[string][]string

+ func (c *Comments) Rename(origin, target string) bool

+ func (c *Comments) String() string

+ type Container struct

+ func NewContainer(root string) *Container

+ func (ac *Container) AddDescriptor(descriptors ...definition.Descriptor)

+ func (ac *Container) AddModifier(modifiers ...service.DefinitionModifier)

+ func (ac *Container) Generate() (*Definitions, error)

+ type Definition struct

+ Consumes []string

+ Description string

+ ErrorProduces []string

+ Examples []Example

+ Function TypeName

+ HTTPCode int

+ HTTPMethod string

+ Method definition.Method

+ Parameters []Parameter

+ Produces []string

+ Results []Result

+ Summary string

+ func NewDefinition(tc *TypeContainer, d *definition.Definition) (*Definition, error)

+ func NewDefinitions(tc *TypeContainer, definitions []definition.Definition) ([]Definition, error)

+ type Definitions struct

+ Definitions map[string][]Definition

+ Types map[TypeName]*Type

+ func (d *Definitions) Subset(require func(path string, def *Definition) bool) *Definitions

+ type Example struct

+ Description string

+ Instance []byte

+ Type TypeName

+ type FuncField struct

+ Name string

+ Type TypeName

+ type Parameter struct

+ Default []byte

+ Description string

+ Name string

+ Source definition.Source

+ Type TypeName

+ type Result struct

+ Description string

+ Destination definition.Destination

+ Type TypeName

+ type StructField struct

+ Anonymous bool

+ Comments string

+ Index []int

+ Name string

+ Offset uintptr

+ PkgPath string

+ Tag reflect.StructTag

+ Type TypeName

+ type Type struct

+ Comments string

+ Conflict int

+ Elem TypeName

+ Fields []StructField

+ In []FuncField

+ Key TypeName

+ Kind reflect.Kind

+ Name string

+ Out []FuncField

+ PkgPath string

+ func (t *Type) RawTypeName() TypeName

+ func (t *Type) TypeName() TypeName

+ type TypeContainer struct

+ func NewTypeContainer() *TypeContainer

+ func (tc *TypeContainer) Complete(analyzer *Analyzer) error

+ func (tc *TypeContainer) NameOf(typ reflect.Type) TypeName

+ func (tc *TypeContainer) NameOfInstance(ins interface{}) TypeName

+ func (tc *TypeContainer) Type(name TypeName) *Type

+ func (tc *TypeContainer) Types() map[TypeName]*Type

+ type TypeName string

v0.2.0-alpha.2

Jul 9, 2018

v0.2.0-alpha.1

Jul 6, 2018

v0.2.0-alpha.0

Jun 27, 2018