mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-06 12:37:49 +00:00
8717b3cd33
Every `Build()` method now requires a `context.Context`. This is so the rolodex knows where to resolve from when locating relative links. Without knowing where we are, there is no way to resolve anything. This new mechanism allows the model to recurse across as many files as required to locate references, without loosing track of where we are in the process. Signed-off-by: quobix <dave@quobix.com>
41 lines
1.2 KiB
Go
41 lines
1.2 KiB
Go
// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package v3
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/pb33f/libopenapi/utils"
|
|
"os"
|
|
|
|
"github.com/pb33f/libopenapi/datamodel"
|
|
lowv3 "github.com/pb33f/libopenapi/datamodel/low/v3"
|
|
)
|
|
|
|
// An example of how to create a new high-level OpenAPI 3+ document from an OpenAPI specification.
|
|
func Example_createHighLevelOpenAPIDocument() {
|
|
// Load in an OpenAPI 3+ specification as a byte slice.
|
|
data, _ := os.ReadFile("../../../test_specs/petstorev3.json")
|
|
|
|
// Create a new *datamodel.SpecInfo from bytes.
|
|
info, _ := datamodel.ExtractSpecInfo(data)
|
|
|
|
var err error
|
|
|
|
// Create a new low-level Document, capture any errors thrown during creation.
|
|
lowDoc, err = lowv3.CreateDocumentFromConfig(info, datamodel.NewOpenDocumentConfiguration())
|
|
|
|
// Get upset if any errors were thrown.
|
|
for i := range utils.UnwrapErrors(err) {
|
|
fmt.Printf("error: %v", i)
|
|
}
|
|
|
|
// Create a high-level Document from the low-level one.
|
|
doc := NewDocument(lowDoc)
|
|
|
|
// Print out some details
|
|
fmt.Printf("Petstore contains %d paths and %d component schemas",
|
|
len(doc.Paths.PathItems), len(doc.Components.Schemas))
|
|
// Output: Petstore contains 13 paths and 8 component schemas
|
|
}
|