openapi

Documentation

Index

• type ABI2Swagger
  • func NewABI2Swagger(conf *ABI2SwaggerConf) *ABI2Swagger
  • func (c *ABI2Swagger) Gen4Factory(basePath, name string, factoryOnly, externalRegistry bool, abi *ethbinding.ABI, ...) *spec.Swagger
  • func (c *ABI2Swagger) Gen4Instance(basePath, name string, abi *ethbinding.ABI, devdocsJSON string) *spec.Swagger
• type ABI2SwaggerConf

Types

type ABI2Swagger

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

ABI2Swagger is the main entry point for conversion

func NewABI2Swagger

func NewABI2Swagger(conf *ABI2SwaggerConf) *ABI2Swagger

NewABI2Swagger constructor

func (*ABI2Swagger) Gen4Factory

func (c *ABI2Swagger) Gen4Factory(basePath, name string, factoryOnly, externalRegistry bool, abi *ethbinding.ABI, devdocsJSON string) *spec.Swagger

Gen4Factory generates OpenAPI for a contract factory, with a constructor, and child methods on any address

func (*ABI2Swagger) Gen4Instance

func (c *ABI2Swagger) Gen4Instance(basePath, name string, abi *ethbinding.ABI, devdocsJSON string) *spec.Swagger

Gen4Instance generates OpenAPI for a single contract instance with an address

type ABI2SwaggerConf

type ABI2SwaggerConf struct {
	ExternalHost     string
	ExternalSchemes  []string
	ExternalRootPath string
	BasicAuth        bool
	OrionPrivateAPI  bool
}

ABI2SwaggerConf are configuration options