https://github.com/kiota-community/kiota-js-extra

Extra tools for working with Kiota in javascript.
https://github.com/kiota-community/kiota-js-extra

Last synced: 6 days ago
JSON representation

Extra tools for working with Kiota in javascript.

• Host: GitHub
• URL: https://github.com/kiota-community/kiota-js-extra
• Owner: kiota-community
• License: apache-2.0
• Created: 2023-10-06T13:03:23.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-22T17:20:31.000Z (11 months ago)
• Last Synced: 2024-10-31T17:09:07.083Z (15 days ago)
• Language: JavaScript
• Size: 74.2 KB
• Stars: 3
• Watchers: 4
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kiota-gen

Kiota Gen is a wrapper around the Kiota CLI tool that is used to generated client SDKs

from OpenAPI specifications.

This package can be used, for example, in a standard node.js/npm project to generate

a client for a REST API.

## Usage

In your `package.json` file, you must add the `@kiota-community/kiota-gen` package

as a dev dependency, something like this:

```json

{

  "name": "kiota-gen-example",

  "version": "0.1.0",

  "devDependencies": {

    "@kiota-community/kiota-gen": "0.1.0"

  }

}

```

Once this is done, and `npm install` is run, you can use `kiota`` as a command in the

`scripts` section of your `package.json`.  For example:

```json

{

  "name": "kiota-gen-example",

  "version": "0.1.0",

  "scripts": {

    "kiota-help": "kiota --help",

    "kiota-generate": "kiota generate -l typescript -d openapi.yaml -c MyGeneratedClient -o ./client"

  }

}

```

See the [documentation for Kiota](https://learn.microsoft.com/en-us/openapi/kiota/using) for more 

information on usage of the Kiota CLI.

## Options

By default, this package will use the most recent version of Kiota, downloaded from the

Kiota GitHub repository (based on the most recent GitHub release of Kiota).  It will 

download and unpack that released binary to a temporary local location and execute the

CLI from there.

You can optionally customize the above behavior. This is done by setting ENV variables.

The following ENV variables are available:

| Variable Name       | Description                   | Default Value |

| ------------------- | ----------------------------- | ------------- |

| KIOTA_VERSION       | The version of Kiota to use.  | `latest`      |

| KIOTA_DOWNLOAD_URL  | Where to download Kiota from. | `https://github.com/microsoft/kiota/releases/download` |

| KIOTA_DOWNLOAD_DIR  | Where to download Kiota to.   | `./.kiota`    |