Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
.github/ | H | 07-Feb-2021 | - | |||
fixtures/ | H | 07-Feb-2021 | - | |||
schemas/ | H | 07-Feb-2021 | - | |||
.editorconfig | H A D | 07-Feb-2021 | 539 | |||
.gitignore | H A D | 07-Feb-2021 | 25 | |||
.golangci.yml | H A D | 07-Feb-2021 | 636 | |||
.travis.yml | H A D | 07-Feb-2021 | 1.3 KiB | |||
CODE_OF_CONDUCT.md | H A D | 07-Feb-2021 | 3.2 KiB | |||
LICENSE | H A D | 07-Feb-2021 | 11.1 KiB | |||
README.md | H A D | 07-Feb-2021 | 2.1 KiB | |||
appveyor.yml | H A D | 07-Feb-2021 | 1.3 KiB | |||
auth_test.go | H A D | 07-Feb-2021 | 4.6 KiB | |||
bindata.go | H A D | 07-Feb-2021 | 24.4 KiB | |||
cache.go | H A D | 07-Feb-2021 | 2.5 KiB | |||
cache_test.go | H A D | 07-Feb-2021 | 676 | |||
circular_test.go | H A D | 07-Feb-2021 | 9.7 KiB | |||
contact_info.go | H A D | 07-Feb-2021 | 1.6 KiB | |||
contact_info_test.go | H A D | 07-Feb-2021 | 1.4 KiB | |||
debug.go | H A D | 07-Feb-2021 | 1.3 KiB | |||
debug_test.go | H A D | 07-Feb-2021 | 1.3 KiB | |||
errors.go | H A D | 07-Feb-2021 | 902 | |||
expander.go | H A D | 07-Feb-2021 | 16.7 KiB | |||
expander_test.go | H A D | 07-Feb-2021 | 40.1 KiB | |||
external_docs.go | H A D | 07-Feb-2021 | 918 | |||
external_docs_test.go | H A D | 07-Feb-2021 | 1 KiB | |||
go.mod | H A D | 07-Feb-2021 | 345 | |||
go.sum | H A D | 07-Feb-2021 | 5.9 KiB | |||
header.go | H A D | 07-Feb-2021 | 4.9 KiB | |||
header_test.go | H A D | 07-Feb-2021 | 4.3 KiB | |||
helpers_spec_test.go | H A D | 07-Feb-2021 | 4 KiB | |||
helpers_test.go | H A D | 07-Feb-2021 | 4.9 KiB | |||
info.go | H A D | 07-Feb-2021 | 4.3 KiB | |||
info_test.go | H A D | 07-Feb-2021 | 2.4 KiB | |||
items.go | H A D | 07-Feb-2021 | 5.8 KiB | |||
items_test.go | H A D | 07-Feb-2021 | 4.5 KiB | |||
license.go | H A D | 07-Feb-2021 | 1.5 KiB | |||
license_test.go | H A D | 07-Feb-2021 | 1.3 KiB | |||
normalizer.go | H A D | 07-Feb-2021 | 6.2 KiB | |||
normalizer_nonwindows.go | H A D | 07-Feb-2021 | 1.2 KiB | |||
normalizer_test.go | H A D | 07-Feb-2021 | 16.3 KiB | |||
normalizer_windows.go | H A D | 07-Feb-2021 | 5.1 KiB | |||
operation.go | H A D | 07-Feb-2021 | 10.8 KiB | |||
operation_test.go | H A D | 07-Feb-2021 | 9.5 KiB | |||
parameter.go | H A D | 07-Feb-2021 | 10.3 KiB | |||
parameters_test.go | H A D | 07-Feb-2021 | 4.8 KiB | |||
path_item.go | H A D | 07-Feb-2021 | 2.6 KiB | |||
path_item_test.go | H A D | 07-Feb-2021 | 2.4 KiB | |||
paths.go | H A D | 07-Feb-2021 | 2.6 KiB | |||
paths_test.go | H A D | 07-Feb-2021 | 1.2 KiB | |||
properties.go | H A D | 07-Feb-2021 | 2.4 KiB | |||
properties_test.go | H A D | 07-Feb-2021 | 2.1 KiB | |||
ref.go | H A D | 07-Feb-2021 | 4.2 KiB | |||
ref_test.go | H A D | 07-Feb-2021 | 1.2 KiB | |||
resolver.go | H A D | 07-Feb-2021 | 3.8 KiB | |||
resolver_test.go | H A D | 07-Feb-2021 | 12.8 KiB | |||
response.go | H A D | 07-Feb-2021 | 4.2 KiB | |||
response_test.go | H A D | 07-Feb-2021 | 2.8 KiB | |||
responses.go | H A D | 07-Feb-2021 | 3.6 KiB | |||
schema.go | H A D | 07-Feb-2021 | 18.2 KiB | |||
schema_loader.go | H A D | 07-Feb-2021 | 8.9 KiB | |||
schema_test.go | H A D | 07-Feb-2021 | 6.6 KiB | |||
security_scheme.go | H A D | 07-Feb-2021 | 5.7 KiB | |||
spec.go | H A D | 07-Feb-2021 | 2.2 KiB | |||
spec_test.go | H A D | 07-Feb-2021 | 12.7 KiB | |||
structs_test.go | H A D | 07-Feb-2021 | 3.9 KiB | |||
swagger.go | H A D | 07-Feb-2021 | 11.9 KiB | |||
swagger_test.go | H A D | 07-Feb-2021 | 11.3 KiB | |||
tag.go | H A D | 07-Feb-2021 | 2.2 KiB | |||
validations.go | H A D | 07-Feb-2021 | 7.1 KiB | |||
validations_test.go | H A D | 07-Feb-2021 | 3 KiB | |||
xml_object.go | H A D | 07-Feb-2021 | 1.9 KiB | |||
xml_object_test.go | H A D | 07-Feb-2021 | 1.9 KiB |
README.md
1# OAI object model 2 3[![Build Status](https://travis-ci.org/go-openapi/spec.svg?branch=master)](https://travis-ci.org/go-openapi/spec) 4<!-- [![Build status](https://ci.appveyor.com/api/projects/status/x377t5o9ennm847o/branch/master?svg=true)](https://ci.appveyor.com/project/casualjim/go-openapi/spec/branch/master) --> 5[![codecov](https://codecov.io/gh/go-openapi/spec/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/spec) 6[![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io) 7[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/spec/master/LICENSE) 8[![Go Reference](https://pkg.go.dev/badge/github.com/go-openapi/spec.svg)](https://pkg.go.dev/github.com/go-openapi/spec) 9[![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/spec)](https://goreportcard.com/report/github.com/go-openapi/spec) 10 11The object model for OpenAPI specification documents. 12 13### FAQ 14 15* What does this do? 16 17> 1. This package knows how to marshal and unmarshal Swagger API specifications into a golang object model 18> 2. It knows how to resolve $ref and expand them to make a single root document 19 20* How does it play with the rest of the go-openapi packages ? 21 22> 1. This package is at the core of the go-openapi suite of packages and [code generator](https://github.com/go-swagger/go-swagger) 23> 2. There is a [spec loading package](https://github.com/go-openapi/loads) to fetch specs as JSON or YAML from local or remote locations 24> 3. There is a [spec validation package](https://github.com/go-openapi/validate) built on top of it 25> 4. There is a [spec analysis package](https://github.com/go-openapi/analysis) built on top of it, to analyze, flatten, fix and merge spec documents 26 27* Does this library support OpenAPI 3? 28 29> No. 30> This package currently only supports OpenAPI 2.0 (aka Swagger 2.0). 31> There is no plan to make it evolve toward supporting OpenAPI 3.x. 32> This [discussion thread](https://github.com/go-openapi/spec/issues/21) relates the full story. 33> 34> An early attempt to support Swagger 3 may be found at: https://github.com/go-openapi/spec3 35