Skip to main content
Version: 1.x

Using Plugins

To use a plugin, install the plugin npm package:

npm install --save-dev @zenstackhq/openapi

Many plugins are design-time only, and you should install them as dev dependencies. However, some plugins are also used at runtime and need to be installed as regular dependencies. Refer to the plugin's documentation for details.

Then add a plugin declaration in your ZModel:

plugin openapi {
provider = "@zenstackhq/openapi"
output = "openapi.yaml"
title = "My Todo API"
version = "1.0.0"

A plugin declaration requires a mandatory provider field that specifies the package name or Javascript module path of the plugin (which the zenstack CLI imports directly with require()). It can also contain other mandatory and optional fields specific to the plugin.

When you run zenstack generate, the plugin will be executed and generate the output files.

Feel free to ask questions, give feedback, or report issues.

Don't Spam

You can edit/delete your comments by going directly to the discussion, clicking on the 'comments' link below