learn-build-service-prod[bot]
commented
1 year ago Learn Build status updates of commit 2a6f3ef:
:warning: Validation status: warnings
| File | Status | Preview URL | Details |
|---|---|---|---|
| OpenAPI/kiota/install.md | :warning:Warning | Details | |
| OpenAPI/kiota/images/community/rest-api-client-generator/add-new.png | :white_check_mark:Succeeded | ||
| OpenAPI/kiota/images/community/rest-api-client-generator/custom-tool-experience.png | :white_check_mark:Succeeded | ||
| OpenAPI/kiota/images/community/rest-api-client-generator/generate-from-existing.png | :white_check_mark:Succeeded |
OpenAPI/kiota/install.md
- Line 22, Column 3: [Warning: bookmark-not-found]
Cannot find bookmark '#install-rest-api-client-code-generator' in 'kiota/install.md'. - Line 110, Column 44: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/visualstudio/ide/finding-and-using-visual-studio-extensions' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 110, Column 44: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/visualstudio/ide/finding-and-using-visual-studio-extensions' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
christianhelle
jasonjoh
The changes here are based off a suggestion by @baywet in this discussion to add information about REST API Client Code Generator as a community provided tooling option for Kiota.
I added the following to
install.mdREST API Client Code Generator
REST API Client Code Generator is a collection of Visual Studio C# custom tool code generators for OpenAPI specifications. This extension will install Kiota on-demand and will also add the required NuGet packages to build the generated code to the project. The generated code is created as a "code-behind" file to the OpenAPI specifications file in the .NET project. This extension offers same-day releases for new Kiota versions, but this requires updating the extension, which can be configured to be automatically.
Installation:
From Visual Studio (Windows), using the Manage Extensions dialog box (Tools -> Manage Extensions), search for extension called REST API Client Code Generator. This extension is available for Visual Studio 2022 for AMD64 and ARM64 and Visual Studio 2019
For Visual Studio for Mac, follow these instructions
Click on the Download button. The extension will be installed after closing Visual Studio so you will need to do a restart
Usage:
To generate code using Kiota, Right click on a project or location under a project and select Add -> New REST API Client -> Generate with Microsoft Kiota
This will prompt you for a URL to download the OpenAPI specifications file.
If the operation worked successfully then you should see a code-behind file for the OpenAPI specifications. Once you have generated code, all changes to the OpenAPI specifications file will trigger a re-generation of the code-behind file via the KiotaCodeGenerator custom tool
If you already have a OpenAPI specifications file in the project, then you can also generate code using Kiota by right clicking on the file then selecting REST API Client Generator -> Generate with Microsoft Kiota