https://github.com/nasa9084/go-openapi

OpenAPI Specification (OAS) 3.0 implementation for Go
https://github.com/nasa9084/go-openapi

go golang openapi openapi-spec openapi-specification openapi3

Last synced: 5 days ago
JSON representation

OpenAPI Specification (OAS) 3.0 implementation for Go

• Host: GitHub
• URL: https://github.com/nasa9084/go-openapi
• Owner: nasa9084
• License: mit
• Created: 2017-12-05T08:30:55.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-19T11:39:02.000Z (6 months ago)
• Last Synced: 2024-12-16T04:04:17.595Z (12 days ago)
• Topics: go, golang, openapi, openapi-spec, openapi-specification, openapi3
• Language: Go
• Homepage:
• Size: 163 KB
• Stars: 38
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: security_requirement.go

Awesome Lists containing this project

README

        
OpenAPI Specification object model

===

[![GoDoc](https://godoc.org/github.com/nasa9084/go-openapi?status.svg)](https://godoc.org/github.com/nasa9084/go-openapi)

[![Build Status](https://travis-ci.org/nasa9084/go-openapi.svg?branch=master)](https://travis-ci.org/nasa9084/go-openapi)

[![codecov](https://codecov.io/gh/nasa9084/go-openapi/branch/master/graph/badge.svg)](https://codecov.io/gh/nasa9084/go-openapi)

---

**This package is still under development, so the API will be changed without any notification**

## Overview

This is an implementation of [OpenAPI Specification 3.0](https://github.com/OAI/OpenAPI-Specification) object model with some usable functions.

## Synopsis

``` go

package main

import (

    "fmt"

    "github.com/nasa9084/go-openapi"

)

func main() {

    doc, _ := openapi.LoadFile("path/to/spec")

    fmt.Print(doc.Version)

}

```

## Status

* [x] Model definition

* [x] Load OpenAPI 3.0 spec file

* [ ] Resolve Reference object

  * [x] Resolve #/component reference

  * [ ] Resolve other file reference

* [ ] Validation

  * [x] Validate spec values

    * [ ] test for validation

      * [x] Document

      * [x] Info

      * [x] Contact

      * [x] License

      * [x] Server

      * [x] ServerVariable

      * [x] Paths

      * [x] PathItem

      * [x] Operation

      * [x] Parameter

      * [x] RequestBody

      * [x] Responses

      * [x] Response

      * [x] Callbacks

      * [x] Callback

      * [ ] Schema

      * [x] Example

      * [ ] MediaType

      * [ ] Header

      * [ ] Link

      * [ ] Encoding

      * [x] Discriminator

      * [x] XML

      * [x] Components

      * [x] SecurityScheme

      * [x] OAuthFlows

      * [x] OAuthFlow

      * [ ] SecurityRequirement

      * [x] Tag

      * [x] ExternalDocumentation

  * [ ] Validate HTTP Request

  * [ ] Validate HTTP Response