microsoft / vscode-azureapicenter

MIT License
17 stars 13 forks source link

Azure API Center for Visual Studio Code

CI E2E CodeQL codecov

Build, discover, try, and consume APIs using your favorite development environment.

Build

Make APIs you are building discoverable to others by registering them with API Center directly or using CI/CD pipelines in GitHub or Azure DevOps.

Shift-left API design conformance checks into Visual Studio Code with integrated linting support, powered by Spectral.

linting

[Pre-Release] Manage API Analysis for Azure API Center.

Manage API Analysis

Ensure that new API versions don't break API consumers with breaking change detection support, powered by Optic.

Breaking Change Detection

[Pre-Release] Use GitHub Copilot for Azure to design API specifications that comply with API Center governance, ensuring your APIs adhere to best practices and standards through AI assistance.

Github Copilot - Generate OpenAPI specification

[Pre-Release] Generate OpenAPI specification file from API code.

Generate OpenAPI specification

[Pre-Release] Platform API Catalog

data-view

Discover

Find the right API, fast from your organization's hand-crafted API catalog with API Center.

tree-view

Explore

Explore APIs without leaving Visual Studio Code with inline API documentation and interactive 'try it' experience.

view-api-doc

Explore API requests and responses with automated .http file generation powered by the REST Client extension for Visual Studio Code.

generate-http-file

[Pre-Release] Generate markdown documentation for an API definition.

Generate Markdown

Consume

Generate API SDK clients for your favorite language including JavaScript, TypeScript, .NET, Python, Java, and more, powered by the same Microsoft Kiota engine that generates SDKs for Microsoft Graph, GitHub, and more.

generate-api-client

Export API specification document for a specific API either from the tree view or from the command palette

Export API specification

Pre-Release

For the features with [Pre-Release] flag, you need to install pre-release version of the extension.

Contributing

There are many ways in which you can participate in the project, for example:

Telemetry

VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

Code of conduct

See Microsoft Open Source code of conduct.

Trademark

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

End User License Agreement

See EULA.

License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT license.