mirrors

forgejo

mirror of

History

techknowlogick 47f6a4ec3f go1.16 (#14783 )		2021-02-28 18:08:33 -05:00
..
internal	…
.codecov.yml	…
.gitignore	…
.golangci.yml	go1.16 (#14783 )	2021-02-28 18:08:33 -05:00
.travis.yml	go1.16 (#14783 )	2021-02-28 18:08:33 -05:00
CODE_OF_CONDUCT.md	…
LICENSE	…
README.md	go1.16 (#14783 )	2021-02-28 18:08:33 -05:00
analyzer.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
appveyor.yml	go1.16 (#14783 )	2021-02-28 18:08:33 -05:00
debug.go	…
doc.go	…
fixer.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
flatten.go	go1.16 (#14783 )	2021-02-28 18:08:33 -05:00
go.mod	go1.16 (#14783 )	2021-02-28 18:08:33 -05:00
go.sum	go1.16 (#14783 )	2021-02-28 18:08:33 -05:00
mixin.go	…
schema.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00

README.md

OpenAPI initiative analysis

A foundational library to analyze an OAI specification document for easier reasoning about the content.

What's inside?

A analyzer providing methods to walk the functional content of a specification
A spec flattener producing a self-contained document bundle, while preserving $refs
A spec merger ("mixin") to merge several spec documents into a primary spec
A spec "fixer" ensuring that response descriptions are non empty

Documentation

FAQ

Does this library support OpenAPI 3?

No. This package currently only supports OpenAPI 2.0 (aka Swagger 2.0). There is no plan to make it evolve toward supporting OpenAPI 3.x. This discussion thread relates the full story.