Skip to content

go-openapi/loads

Loads OAI specs

Tests Coverage CI vuln scan CodeQL

Release Go Report Card CodeFactor Grade License

GoDoc Slack Channelslack-badge go version Top language Commits since latest release


Loads OAI v2 API specification documents from local or remote locations.

Supports JSON and YAML documents.

Status

API is stable.

Import this library in your project

go get github.com/go-openapi/loads

Basic usage

  import (
	  "github.com/go-openapi/loads"
  )

  ...

	// loads a YAML spec from a http file
	doc, err := loads.Spec(ts.URL)
  
  ...

  // retrieves the object model for the API specification
  spec := doc.Spec()

  ...

See also the provided examples.

Change log

See https://github.com/go-openapi/loads/releases

Licensing

This library ships under the SPDX-License-Identifier: Apache-2.0.

See the license NOTICE, which recalls the licensing terms of all the pieces of software on top of which it has been built.

Other documentation

Cutting a new release

Maintainers can cut a new release by either:

  • running this workflow
  • or pushing a semver tag
    • signed tags are preferred
    • The tag message is prepended to release notes

About

openapi specification object model

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages