Cadl OpenAPI 3.0 Emitter
This package provides the Cadl emitter to produce OpenAPI 3.0 output from Cadl source.
Install
In your cadl project root
npm install @cadl-lang/openapi3Emit OpenAPI 3.0 spec
- Via the command line
cadl compile . --emit @cadl-lang/openapi3- Via the config
Add the following to the cadl-project.yaml file.
emitters:
@cadl-lang/openapi3: trueUse OpenAPI 3.0 specific decorators:
import "@cadl-lang/openapi3";
using OpenAPI.V3;
// Using `using`
@useRef("common.json#/components/schemas/Foo")
model Foo {}
// Using fully qualified names
@OpenAPI.V3.oneOf
union MyUnion {
cat: Cat,
dog: Dog,
}