external-types/

directory
Version: v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 12, 2021 License: Apache-2.0

README

External types examples

The sample specification provided here demonstrates how to bind your generated API with some externally defined types for schemas.

This swagger specification illustrates the following use cases:

  1. refer to an external type imported from some external package, as its own definition
  2. refer to an external type imported from some external package, as part of another type (object, slice, map or tuple)
  3. refer to an external type imported from the default location of models (i.e. besides generated models)
  4. embed external type to add the Validatable interface.
  5. use hints in annotations to solve nullable/struct vs interface issues
  6. use hints in annotations to skip the validation of external types

NOTE: due to the addition of the "additionalItems" clause to illustrate tuples, the spec is not formally valid against the swagger 2.0 schema.

Reference documentation

Directories

Path Synopsis
cmd
Package restapi external types imports: external anonymous types This sample specification exercises external types, with both x-go-type in definitions and inlined.
Package restapi external types imports: external anonymous types This sample specification exercises external types, with both x-go-type in definitions and inlined.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL