extractor

package

v0.0.0-...-9bdd10d Latest Latest Go to latest Published: Feb 10, 2024 License: GPL-3.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

func New(path string) (*Extractor, error)

New parses the file at path and returns an extractor with its contents.

func (e *Extractor) Extract() ([]Route, []Struct)

Extract reads the JSON document and extracts all the routes and structs from it.

type Field struct {
	Name       string
	IsArray    bool
	IsOptional bool
	Type       string
}

type Route struct {
	Name       string
	Summary    string
	Method     string
	Path       string
	ParamsName string
	ReturnName string
}

type Struct struct {
	Name       string
	Fields     []Field
	UnionNames []string
}