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

..24-Mar-2022-

.editorconfigH A D24-Mar-2022539 2721

.gitignoreH A D24-Mar-202225 32

.golangci.ymlH A D24-Mar-2022636 4341

.travis.ymlH A D24-Mar-20221.3 KiB3229

CODE_OF_CONDUCT.mdH A D24-Mar-20223.2 KiB7556

LICENSEH A D24-Mar-202211.1 KiB203169

README.mdH A D24-Mar-20222.1 KiB3525

appveyor.ymlH A D24-Mar-20221.3 KiB3324

bindata.goH A D24-Mar-202224.4 KiB298226

cache.goH A D24-Mar-20222.5 KiB9955

contact_info.goH A D24-Mar-20221.6 KiB5831

debug.goH A D24-Mar-20221.3 KiB5024

errors.goH A D24-Mar-2022902 208

expander.goH A D24-Mar-202216.7 KiB595434

external_docs.goH A D24-Mar-2022918 255

header.goH A D24-Mar-20224.9 KiB204139

info.goH A D24-Mar-20224.3 KiB166118

items.goH A D24-Mar-20225.8 KiB235165

license.goH A D24-Mar-20221.5 KiB5730

normalizer.goH A D24-Mar-20226.2 KiB204102

normalizer_nonwindows.goH A D24-Mar-20221.2 KiB4420

normalizer_windows.goH A D24-Mar-20225.1 KiB15569

operation.goH A D24-Mar-202210.8 KiB398291

parameter.goH A D24-Mar-202210.3 KiB327210

path_item.goH A D24-Mar-20222.6 KiB8856

paths.goH A D24-Mar-20222.6 KiB9867

properties.goH A D24-Mar-20222.4 KiB9274

ref.goH A D24-Mar-20224.2 KiB194135

resolver.goH A D24-Mar-20223.8 KiB12881

response.goH A D24-Mar-20224.2 KiB153105

responses.goH A D24-Mar-20223.6 KiB12883

schema.goH A D24-Mar-202218.2 KiB647469

schema_loader.goH A D24-Mar-20229 KiB339227

security_scheme.goH A D24-Mar-20225.7 KiB171120

spec.goH A D24-Mar-20222.2 KiB7944

swagger.goH A D24-Mar-202211.9 KiB449334

tag.goH A D24-Mar-20222.2 KiB7642

validations.goH A D24-Mar-20227.1 KiB216160

xml_object.goH A D24-Mar-20221.9 KiB6936

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