go-swagger: github.com/go-swagger/go-swagger/cmd/swagger/commands/generate Index | Files

package generate

import "github.com/go-swagger/go-swagger/cmd/swagger/commands/generate"

Index

Package Files

client.go contrib.go model.go operation.go server.go shared.go spec_go111.go support.go

type Client Uses

type Client struct {
    WithShared
    WithModels
    WithOperations

    SkipModels     bool `long:"skip-models" description:"no models will be generated when this flag is specified"`
    SkipOperations bool `long:"skip-operations" description:"no operations will be generated when this flag is specified"`

    Name string `long:"name" short:"A" description:"the name of the application, defaults to a mangled value of info.title"`
    // contains filtered or unexported fields
}

Client the command to generate a swagger client

func (*Client) Execute Uses

func (c *Client) Execute(args []string) error

Execute runs this command

type FlattenCmdOptions Uses

type FlattenCmdOptions struct {
    WithExpand  bool     `long:"with-expand" description:"expands all $ref's in spec prior to generation (shorthand to --with-flatten=expand)"  group:"shared"`
    WithFlatten []string `long:"with-flatten" description:"flattens all $ref's in spec prior to generation" choice:"minimal" choice:"full" choice:"expand" choice:"verbose" choice:"noverbose" choice:"remove-unused" default:"minimal" default:"verbose" group:"shared"` // nolint: staticcheck
}

FlattenCmdOptions determines options to the flatten spec preprocessing

func (*FlattenCmdOptions) SetFlattenOptions Uses

func (f *FlattenCmdOptions) SetFlattenOptions(dflt *analysis.FlattenOpts) (res *analysis.FlattenOpts)

SetFlattenOptions builds flatten options from command line args

type Model Uses

type Model struct {
    WithShared
    WithModels

    NoStruct              bool     `long:"skip-struct" description:"when present will not generate the model struct" hidden:"deprecated"`
    Name                  []string `long:"name" short:"n" description:"the model to generate, repeat for multiple (defaults to all). Same as --models"`
    AcceptDefinitionsOnly bool     `long:"accept-definitions-only" description:"accepts a partial swagger spec wih only the definitions key"`
}

Model the generate model file command.

Define the options that are specific to the "swagger generate model" command.

func (*Model) Execute Uses

func (m *Model) Execute(args []string) error

Execute generates a model file

type Operation Uses

type Operation struct {
    WithShared
    WithOperations

    ModelPackage string `long:"model-package" short:"m" description:"the package to save the models" default:"models"`

    NoHandler    bool `long:"skip-handler" description:"when present will not generate an operation handler"`
    NoStruct     bool `long:"skip-parameters" description:"when present will not generate the parameter model struct"`
    NoResponses  bool `long:"skip-responses" description:"when present will not generate the response model struct"`
    NoURLBuilder bool `long:"skip-url-builder" description:"when present will not generate a URL builder"`

    Name []string `long:"name" short:"n" description:"the operations to generate, repeat for multiple (defaults to all). Same as --operations"`
    // contains filtered or unexported fields
}

Operation the generate operation files command

func (*Operation) Execute Uses

func (o *Operation) Execute(args []string) error

Execute generates a model file

type Server Uses

type Server struct {
    WithShared
    WithModels
    WithOperations

    SkipModels             bool   `long:"skip-models" description:"no models will be generated when this flag is specified"`
    SkipOperations         bool   `long:"skip-operations" description:"no operations will be generated when this flag is specified"`
    SkipSupport            bool   `long:"skip-support" description:"no supporting files will be generated when this flag is specified"`
    ExcludeMain            bool   `long:"exclude-main" description:"exclude main function, so just generate the library"`
    ExcludeSpec            bool   `long:"exclude-spec" description:"don't embed the swagger specification"`
    FlagStrategy           string `long:"flag-strategy" description:"the strategy to provide flags for the server" default:"go-flags" choice:"go-flags" choice:"pflag" choice:"flag"` // nolint: staticcheck
    CompatibilityMode      string `long:"compatibility-mode" description:"the compatibility mode for the tls server" default:"modern" choice:"modern" choice:"intermediate"`          // nolint: staticcheck
    RegenerateConfigureAPI bool   `long:"regenerate-configureapi" description:"Force regeneration of configureapi.go"`

    Name string `long:"name" short:"A" description:"the name of the application, defaults to a mangled value of info.title"`

    //deprecated flags
    WithContext bool `long:"with-context" description:"handlers get a context as first arg (deprecated)"`
    // contains filtered or unexported fields
}

Server the command to generate an entire server application

func (*Server) Execute Uses

func (s *Server) Execute(args []string) error

Execute runs this command

type SpecFile Uses

type SpecFile struct {
    WorkDir     string         `long:"work-dir" short:"w" description:"the base path to use" default:"."`
    BuildTags   string         `long:"tags" short:"t" description:"build tags" default:""`
    ScanModels  bool           `long:"scan-models" short:"m" description:"includes models that were annotated with 'swagger:model'"`
    Compact     bool           `long:"compact" description:"when present, doesn't prettify the json"`
    Output      flags.Filename `long:"output" short:"o" description:"the file to write to"`
    Input       flags.Filename `long:"input" short:"i" description:"the file to use as input"`
    Include     []string       `long:"include" short:"c" description:"include packages matching pattern"`
    Exclude     []string       `long:"exclude" short:"x" description:"exclude packages matching pattern"`
    IncludeTags []string       `long:"include-tag" short:"" description:"include routes having specified tags (can be specified many times)"`
    ExcludeTags []string       `long:"exclude-tag" short:"" description:"exclude routes having specified tags (can be specified many times)"`
    ExcludeDeps bool           `long:"exclude-deps" short:"" description:"exclude all dependencies of project"`
}

SpecFile command to generate a swagger spec from a go application

func (*SpecFile) Execute Uses

func (s *SpecFile) Execute(args []string) error

Execute runs this command

type Support Uses

type Support struct {
    WithShared
    WithModels
    WithOperations

    Name string `long:"name" short:"A" description:"the name of the application, defaults to a mangled value of info.title"`
    // contains filtered or unexported fields
}

Support generates the supporting files

func (*Support) Execute Uses

func (s *Support) Execute(args []string) error

Execute generates the supporting files file

type WithModels Uses

type WithModels struct {
    Models modelOptions `group:"Options for model generation"`
}

WithModels adds the model options group.

This group is available to all commands that need some model generation.

type WithOperations Uses

type WithOperations struct {
    Operations operationOptions `group:"Options for operation generation"`
}

WithOperations adds the operations options group

type WithShared Uses

type WithShared struct {
    Shared sharedOptions `group:"Options common to all code generation commands"`
}

WithShared adds the shared options group

Package generate imports 17 packages (graph) and is imported by 3 packages. Updated 2020-07-15. Refresh now. Tools for package owners.