File: yaml.go

package info (click to toggle)
golang-github-go-openapi-swag 1%3A0.25.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,200 kB
  • sloc: sh: 30; makefile: 3
file content (48 lines) | stat: -rw-r--r-- 1,385 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
// Copyright 2015 go-swagger maintainers
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//	http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package loading

import (
	"encoding/json"
	"path/filepath"

	"github.com/go-openapi/swag/yamlutils"
)

// YAMLMatcher matches yaml for a file loader.
func YAMLMatcher(path string) bool {
	ext := filepath.Ext(path)
	return ext == ".yaml" || ext == ".yml"
}

// YAMLDoc loads a yaml document from either http or a file and converts it to json.
func YAMLDoc(path string, opts ...Option) (json.RawMessage, error) {
	yamlDoc, err := YAMLData(path, opts...)
	if err != nil {
		return nil, err
	}

	return yamlutils.YAMLToJSON(yamlDoc)
}

// YAMLData loads a yaml document from either http or a file.
func YAMLData(path string, opts ...Option) (interface{}, error) {
	data, err := LoadFromFileOrHTTP(path, opts...)
	if err != nil {
		return nil, err
	}

	return yamlutils.BytesToYAMLDoc(data)
}