kiota/vscode/microsoft-kiota/README.md

2.9 KiB
Исходник Постоянная ссылка Ответственный История

Microsoft Kiota

Kiota is a client generator for HTTP REST APIs described by OpenAPI. The experience is available as a command-line tool and as a Visual Studio Code extension. Kiota helps eliminate the need to take a dependency on a different API client for every API that you need to call, as well as limiting the generation to the exact API surface area youre interested in, thanks to a filtering capability.

Features

Using kiota you can:

  1. Search for API descriptions.
  2. Filter and select the API endpoints you need.
  3. Generate models and a chained method API surface in the language of your choice.
  4. Call the API with the new client.

All that in a matter of seconds.

Microsoft Kiota extension for Visual Studio Code

This Visual Studio Code (VS Code) extension adds a rich UI for the Kiota experience. The features include all of Kiota capabilities such as search for API descriptions, filtering and generating API clients and more!

  • Once the extension is installed, you will be able to see the commands available to you.
VScode extension commands
  • Search for an API description using a keyword
vscode extension search vscode extension search results
  • Select the OpenAPI description you are interested in and you will be presented with the Kiota OpenAPI Explorer containing all the available endpoints
Kiota OpenAPI explorer
  • Select the endpoints to include in your API client
kiota vscode select endpoint
  • Finally, you can generate the API client. You will be prompted to provide some parameters for your client such as the class and namespace names. You will also need to select the language for the generated client.
generation complete

Requirements

None.

Extension Settings

None.

Known Issues

Checkout the list of open issues to get a list of the known issues.

Release Notes

Checkout the release notes to get more information about each release.