@azure-tools/adl-vs
npm i @azure-tools/adl-vs
Deprecated!
This package has been replaced by cadl-vs

@azure-tools/adl-vs

ADL - Api Description Language

by Azure

0.2.0 (see all)License:MITTypeScript:Not Found
npm i @azure-tools/adl-vs
Readme

ADL

This project is a work in progress, more information will be provided at a later date.

You can try a work-in-progress build of the compiler by following the steps in the Installation section below. Please feel free to file issues for any issues you encounter while using the preview.

Installation

You can install the current preview build of ADL using Node.js (14+) and npm:

npm install -g @azure-tools/adl

ADL will now be accessible via the adl command in your shell.

Usage

See full usage documentation by typing:

adl --help

You can launch ADL in one of two ways:

Compiling a folder of ADL files to an OpenAPI 2.0 (Swagger) specification

You can compile a folder containing .adl files into a single OpenAPI document by using the following command:

adl compile samples/petstore/

You can now examine the emitted OpenAPI document in ./adl-output/openapi.json.

Generating a TypeScript client from a folder of ADL files

You can compile a folder containing .adl files into a single OpenAPI document by using the following command:

adl generate --client samples/petstore/

Parameters for generating clients in other languages will be added soon.

Downloads/wk

15

GitHub Stars

27

LAST COMMIT

1yr ago

MAINTAINERS

1

CONTRIBUTORS

13

OPEN ISSUES

40

OPEN PRs

11
VersionTagPublished
0.2.0
latest
10mos ago
No alternatives found
No tutorials found
Add a tutorial