Skip to content

Add support for OpenAPI 3 #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ndeloof wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add support for OpenAPI 3 #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ require (
)

go 1.24.0

replace github.com/go-openapi/spec => ../spec
30 changes: 21 additions & 9 deletions spec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,6 @@ func Spec(path string, opts ...LoaderOption) (*Document, error) {

// Analyzed creates a new analyzed spec document for a root json.RawMessage.
func Analyzed(data json.RawMessage, version string, options ...LoaderOption) (*Document, error) {
if version == "" {
version = "2.0"
}
if version != "2.0" {
return nil, fmt.Errorf("spec version %q is not supported: %w", version, ErrLoads)
}

raw, err := trimData(data) // trim blanks, then convert yaml docs into json
if err != nil {
return nil, err
Expand All @@ -120,9 +113,24 @@ func Analyzed(data json.RawMessage, version string, options ...LoaderOption) (*D
return nil, errors.Join(err, ErrLoads)
}

// Auto-detect spec version and select appropriate schema
var schema *spec.Schema
if swspec.Swagger == "2.0" {
// Swagger 2.0 spec
schema = spec.MustLoadSwagger20Schema()
} else if swspec.OpenAPI != "" {
// OpenAPI 3.x spec
schema = spec.MustLoadOpenAPI32Schema()
} else if version == "2.0" || version == "" {
// Default to Swagger 2.0 for backward compatibility
schema = spec.MustLoadSwagger20Schema()
} else {
schema = spec.MustLoadOpenAPI32Schema()
}

d := &Document{
Analyzer: analysis.New(swspec), // NOTE: at this moment, analysis does not follow $refs to documents outside the root doc
schema: spec.MustLoadSwagger20Schema(),
schema: schema,
spec: swspec,
raw: raw,
origSpec: origsqspec,
Expand Down Expand Up @@ -208,8 +216,12 @@ func (d *Document) BasePath() string {
return d.spec.BasePath
}

// Version returns the OpenAPI version of this spec (e.g. 2.0).
// Version returns the OpenAPI version of this spec (e.g. 2.0 or 3.0.0 for OpenAPI).
func (d *Document) Version() string {
// Check OpenAPI v3 version first
if d.spec.OpenAPI != "" {
return d.spec.OpenAPI
}
return d.spec.Swagger
}

Expand Down