package
1.4.2
Repository: https://github.com/jerejones/oapi-codegen.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

This function walks the given parameters dictionary, and generates the above descriptors into a flat list.
No description provided by the author
This function returns the subset of the specified parameters which are of the specified type.
Uses the Go templating engine to generate all of our server wrappers from the descriptions we've built up above from the schema objects.
Generate all the glue code which provides the API for interacting with additional properties and JSON-ification.
This function turns the Swagger body definitions into a list of our body definitions which will be used for code generation.
GenerateChiServer This function generates all the go code for the ServerInterface as well as all the wrapper functions around our handlers.
Uses the template engine to generate the function which registers our wrappers as Echo path handlers.
This generates a client which extends the basic client which does response unmarshaling.
GenerateEchoServer This function generates all the go code for the ServerInterface as well as all the wrapper functions around our handlers.
No description provided by the author
Generate our import statements and package definition.
This generates a gzipped, base64 encoded JSON representation of the swagger definition, which we embed inside the generated code.
This defines the schema for a parameters definition object which encapsulates all the query, header and cookie parameters for an operation.
Uses the template engine to generate the function which registers our wrappers as Echo path handlers.
Uses the template engine to generate the server interface.
No description provided by the author
No description provided by the author
Helper function to pass a bunch of types to the template engine, and buffer its output into a string.
Generates code for all types produced.
Generates type definitions for any custom types defined in the components/parameters section of the Swagger spec.
Generates type definitions for any custom types defined in the components/requestBodies section of the Swagger spec.
Generates type definitions for any custom types defined in the components/responses section of the Swagger spec.
Generates type definitions for any custom types defined in the components/schemas section of the Swagger spec.
Uses the template engine to generate all the wrappers which wrap our simple interface functions and perform marshallin/unmarshalling from HTTP request objects.
Given a list of schema descriptors, produce corresponding field names with JSON annotations.
This function generates an object that is the union of the objects in the input array.
No description provided by the author
Returns whether the given string is a go keyword.
Same as above, except lower case.
Merge all the fields in the schemas supplied into one giant schema.
OperationDefinitions returns all operations for a swagger definition.
Returns the argument names, in order, in a given URI string, so for /path/{param1}/{.param2*}/{?param3}, it would return param1, param2, param3.
This converts a path, like Object/field1/nestedField into a go type name.
No description provided by the author
This function takes a $ref value and converts it to a Go typename.
Replaces path parameters with %s.
SanitizeCode runs sanitizers across the generated Go code to ensure the generated code will be able to compile.
According to the spec, additionalProperties may be true, false, or a schema.
Converts a Schema name to a valid Go type name.
This returns Content dictionary keys in sorted order.
This function returns Operation dictionary keys in sorted order.
This returns sorted keys for a ParameterRef dict.
This function is the same as above, except it sorts the keys for a Paths dictionary.
No description provided by the author
This function returns Responses dictionary keys in sorted order.
This function returns the keys of the given SchemaRef dictionary in sorted order, since Golang scrambles dictionary keys.
This returns string map keys in sorted order.
Reorders the given parameter definitions to match those in the path URI.
This function checks whether the specified string is present in an array of strings.
StringToGoComment renders a possible multi-line string as a valid Go-Comment.
This function converts a swagger style path URI with parameters to a Chi compatible path URI.
This function converts a swagger style path URI with parameters to a Echo compatible path URI.
This function will convert query-arg style strings to CamelCase.
Uppercase the first character in a string.

# Variables

This function map is passed to the template engine, and we can call each function here by keyName from the template code.

# Structs

No description provided by the author
This structure describes an Operation.
Options defines the optional code to generate.
No description provided by the author
No description provided by the author
This describes a request body.
This describes a Schema, a type definition.
This describes a Schema, a type definition.
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author