package
1.0.9
Repository: https://github.com/trpc-group/trpc-cmdline.git
Documentation: pkg.go.dev

# Packages

Package openapi provides the ability to manipulate OpenAPI documents.
Package swagger provides the ability to manipulate swagger documentation.
Package x provides common utilities for documentation operations.

# Functions

NewDefinitions returns a Definition instance.
NewInfo inits Info instance.
NewOpenAPIJSON returns a new OpenAPIJSON instance.
NewPaths inits Path.
NewProperties new.
NewProperty new.
NewSwagger generates swagger documents.
OrderedMarshalJSON serializes data to JSON while preserving the order of keys.
OrderedUnmarshalJSON deserializes JSON data while preserving the order of keys.
WriteJSON writes JSON.

# Variables

GetNameByRef gets the name from a reference.
RefName returns a reference with the specified name.

# Structs

BodyContentStruct defines the structure of the response in OpenAPI JSON for a given method.
ComponentStruct component struct.
Definitions models.
InfoStruct defines the structure of the documentation description information contained in the apidocs header.
MediaStruct defines the structure of the response in api docs json for a given method.
Methods is the set of methods.
MethodStruct defines the detailed information of a method in apidocs.
MethodStructX defines the detailed information of a method in OpenAPI JSON.
MethodsX for v3.
ModelStruct defines the structure of the whole data model in the apidocs JSON.
OpenAPIJSON defines the structure of the JSON file that OpenAPI API documentation needs to load.
ParametersStruct defines the structure of input parameters information for methods in Swagger JSON format.
ParameterStructX for v3.
Paths is the set of Path.
PathsX for v3.
Properties Properties.
PropertyStruct defines the structure of a single field of a data model in the api docs json.
SchemaStruct defines the structure of schema used by data model in api docs json.
SwaggerJSON defines the structure of the JSON that contains the swagger API documentation.

# Type aliases

NewPropertyFunc factory.