parser

package
v0.0.0-...-177ac96 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 5, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package parser provides OpenAPI specification parsing functionality.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Parser

type Parser struct {
	// The loaded OpenAPI document
	Doc *openapi3.T

	// Generator for type conversions
	TypeMapping     map[string]string
	GetTypeFunc     func(schemaType, format string) string
	ToModelNameFunc func(name string) string
	ToVarNameFunc   func(name string) string

	// Validation settings
	SkipValidation bool

	// Collected validation errors and warnings
	ValidationErrors   []string
	ValidationWarnings []string
}

Parser parses OpenAPI specifications and converts them to codegen models.

func NewParser

func NewParser() *Parser

NewParser creates a new OpenAPI parser.

func (*Parser) GetBasePath

func (p *Parser) GetBasePath() string

GetBasePath returns the base path from servers.

func (*Parser) GetInfo

func (p *Parser) GetInfo() map[string]string

GetInfo returns basic info about the API.

func (*Parser) GetModels

func (p *Parser) GetModels() ([]*codegen.CodegenModel, error)

GetModels extracts all models from the OpenAPI spec.

func (*Parser) GetOperations

func (p *Parser) GetOperations() (map[string][]*codegen.CodegenOperation, error)

GetOperations extracts all operations grouped by tag.

func (*Parser) GetSecuritySchemes

func (p *Parser) GetSecuritySchemes() ([]*codegen.CodegenSecurity, error)

GetSecuritySchemes extracts security schemes.

func (*Parser) LoadFromData

func (p *Parser) LoadFromData(data []byte) error

LoadFromData loads an OpenAPI spec from raw data.

func (*Parser) LoadFromFile

func (p *Parser) LoadFromFile(path string) error

LoadFromFile loads an OpenAPI spec from a file.

func (*Parser) LoadFromURL

func (p *Parser) LoadFromURL(urlStr string) error

LoadFromURL loads an OpenAPI spec from a URL.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL