• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

.github/H07-Feb-2021-

fixtures/H07-Feb-2021-

schemas/H07-Feb-2021-

.editorconfigH A D07-Feb-2021539

.gitignoreH A D07-Feb-202125

.golangci.ymlH A D07-Feb-2021636

.travis.ymlH A D07-Feb-20211.3 KiB

CODE_OF_CONDUCT.mdH A D07-Feb-20213.2 KiB

LICENSEH A D07-Feb-202111.1 KiB

README.mdH A D07-Feb-20212.1 KiB

appveyor.ymlH A D07-Feb-20211.3 KiB

auth_test.goH A D07-Feb-20214.6 KiB

bindata.goH A D07-Feb-202124.4 KiB

cache.goH A D07-Feb-20212.5 KiB

cache_test.goH A D07-Feb-2021676

circular_test.goH A D07-Feb-20219.7 KiB

contact_info.goH A D07-Feb-20211.6 KiB

contact_info_test.goH A D07-Feb-20211.4 KiB

debug.goH A D07-Feb-20211.3 KiB

debug_test.goH A D07-Feb-20211.3 KiB

errors.goH A D07-Feb-2021902

expander.goH A D07-Feb-202116.7 KiB

expander_test.goH A D07-Feb-202140.1 KiB

external_docs.goH A D07-Feb-2021918

external_docs_test.goH A D07-Feb-20211 KiB

go.modH A D07-Feb-2021345

go.sumH A D07-Feb-20215.9 KiB

header.goH A D07-Feb-20214.9 KiB

header_test.goH A D07-Feb-20214.3 KiB

helpers_spec_test.goH A D07-Feb-20214 KiB

helpers_test.goH A D07-Feb-20214.9 KiB

info.goH A D07-Feb-20214.3 KiB

info_test.goH A D07-Feb-20212.4 KiB

items.goH A D07-Feb-20215.8 KiB

items_test.goH A D07-Feb-20214.5 KiB

license.goH A D07-Feb-20211.5 KiB

license_test.goH A D07-Feb-20211.3 KiB

normalizer.goH A D07-Feb-20216.2 KiB

normalizer_nonwindows.goH A D07-Feb-20211.2 KiB

normalizer_test.goH A D07-Feb-202116.3 KiB

normalizer_windows.goH A D07-Feb-20215.1 KiB

operation.goH A D07-Feb-202110.8 KiB

operation_test.goH A D07-Feb-20219.5 KiB

parameter.goH A D07-Feb-202110.3 KiB

parameters_test.goH A D07-Feb-20214.8 KiB

path_item.goH A D07-Feb-20212.6 KiB

path_item_test.goH A D07-Feb-20212.4 KiB

paths.goH A D07-Feb-20212.6 KiB

paths_test.goH A D07-Feb-20211.2 KiB

properties.goH A D07-Feb-20212.4 KiB

properties_test.goH A D07-Feb-20212.1 KiB

ref.goH A D07-Feb-20214.2 KiB

ref_test.goH A D07-Feb-20211.2 KiB

resolver.goH A D07-Feb-20213.8 KiB

resolver_test.goH A D07-Feb-202112.8 KiB

response.goH A D07-Feb-20214.2 KiB

response_test.goH A D07-Feb-20212.8 KiB

responses.goH A D07-Feb-20213.6 KiB

schema.goH A D07-Feb-202118.2 KiB

schema_loader.goH A D07-Feb-20218.9 KiB

schema_test.goH A D07-Feb-20216.6 KiB

security_scheme.goH A D07-Feb-20215.7 KiB

spec.goH A D07-Feb-20212.2 KiB

spec_test.goH A D07-Feb-202112.7 KiB

structs_test.goH A D07-Feb-20213.9 KiB

swagger.goH A D07-Feb-202111.9 KiB

swagger_test.goH A D07-Feb-202111.3 KiB

tag.goH A D07-Feb-20212.2 KiB

validations.goH A D07-Feb-20217.1 KiB

validations_test.goH A D07-Feb-20213 KiB

xml_object.goH A D07-Feb-20211.9 KiB

xml_object_test.goH A D07-Feb-20211.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