api2

README

Package api2

Purpose

This package extracts schemas metadata from OpenAPI files version 2. If your OpenAPI file is using newer version 3 check out api3 package.

Description

Before extracting metadata from OpenAPI, the schema is initially converted from V2 to V3 format. For further details, refer to the api3 package README, as the remaining process follows the same approach as api3. This pacakge acts as a gateway and a wrapper of api3.

Loading File

var (
    // Static file containing openapi spec.
    //
    //go:embed specs.json
    apiFile []byte

	FileManager = api2.NewOpenapiFileManager(apiFile) // nolint:gochecknoglobals
)

Documentation

Index

• type OpenapiFileManager
  • func NewOpenapiFileManager[C any](file []byte) *OpenapiFileManager[C]
  • func (m OpenapiFileManager[C]) GetExplorer(opts ...api3.Option) (*api3.Explorer[C], error)

Types

type OpenapiFileManager

type OpenapiFileManager[C any] struct {
	// contains filtered or unexported fields
}

OpenapiFileManager locates openapi file. Allows to read data of interest. Use it when dealing with OpenAPI v2.

func NewOpenapiFileManager

func NewOpenapiFileManager[C any](file []byte) *OpenapiFileManager[C]

func (OpenapiFileManager[C]) GetExplorer

func (m OpenapiFileManager[C]) GetExplorer(opts ...api3.Option) (*api3.Explorer[C], error)