Giter Club home page Giter Club logo

cadl-demo's Introduction

Design-first approach with CADL

Demonstrating how we can create an API with CADL

Running the demo

# Installing dependencies
npm install

# Compile the CADL API defined in main.cadl
npm run compile

# View the generated OpenAPI v3 in the local Swagger UI
npm run ui

# Now you can access the Swagger UI using http://localhost:3355

Viewing other examples

# Basic example
npx cadl compile 0-starting-point.cadl

# Consistency and reusability
npx cadl compile 1-consistency-and-reuse.cadl

# Error handling with error models
npx cadl compile 2-error-handling.cadl

# Securing the API
npx cadl compile 3-security-constraints.cadl

# Deprecating endpoints
npx cadl compile 4-deprecations.cadl

# Versioning
npx cadl compile 5-versioning.cadl

# Integration with Azure API Management
npx cadl compile 6-apim.cadl --emit @azure-tools/cadl-autorest
# Now you can view the generated OpenAPI v2 in https://editor.swagger.io/ and import it into your APIM instance

cadl-demo's People

Contributors

ikhemissi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.