Announcing: General Availability of Azure API Center extension for Visual Studio Code
Published Jun 05 2024 03:53 PM 1,347 Views

About Azure API Center extension for Visual Studio Code 

The Azure API Center extension for Visual Studio Code enables developers to build, discover, try, and consume APIs in your API center:

  • Build APIs - Make APIs you're building discoverable to others by registering them in your API center. Shift-left API design conformance checks into Visual Studio Code with integrated linting support. Ensure that new API versions don't break API consumers with breaking change detection. 
  • Discover APIs - Browse the APIs in your API center, and view their details and documentation. 
  • Try APIs - Use Swagger UI or REST client to explore API requests and responses. 
  • Consume APIs - Generate API SDK clients for your favorite language including JavaScript, TypeScript, .NET, Python, and Java, using the Microsoft Kiota engine that generates SDKs for Microsoft Graph, GitHub, and more.

Register APIs

Register an API in your API center directly from Visual Studio Code, either by registering it as a one-time operation or with a CI/CD pipeline.

 

SreekanthThirthalaVenkata_2-1717627055410.png

SreekanthThirthalaVenkata_1-1717626895914.png

API design conformance

To ensure design conformance with organizational standards as you build APIs, the Azure API Center extension for Visual Studio Code provides integrated support for API specification linting with Spectral.

SreekanthThirthalaVenkata_5-1717627230602.png

Breaking change detection

When introducing new versions of your API, it's important to ensure that changes introduced do not break API consumers on previous versions of your API. The Azure API Center extension for Visual Studio Code makes this easy with breaking change detection for OpenAPI specification documents powered by Optic.

SreekanthThirthalaVenkata_6-1717627289062.png

Discover APIs

Your API center resources appear in the tree view on the left-hand side. Expand an API center resource to see APIs, versions, definitions, environments, and deployments.

 

SreekanthThirthalaVenkata_7-1717627409108.png

 

View API documentation

You can view the documentation for an API definition in your API center and try API operations. This feature is only available for OpenAPI-based APIs in your API center.

SreekanthThirthalaVenkata_8-1717627454518.png

Generate HTTP file

You can view a .http file based on the API definition in your API center. If the REST Client extension is installed, you can make requests directory from the Visual Studio Code editor. This feature is only available for OpenAPI-based APIs in your API center.

SreekanthThirthalaVenkata_9-1717627469746.png

 

Generate API client

Use the Microsoft Kiota extension to generate an API client for your favorite language. This feature is only available for OpenAPI-based APIs in your API center.

SreekanthThirthalaVenkata_10-1717627494622.png

Export API specification

You can export an API specification from a definition and then download it as a file.

SreekanthThirthalaVenkata_11-1717627523157.png

 

Get started with Azure API Center extension for Visual Studio Code now!

Azure API Center extension for Visual Studio Code is now generally available, and enables you to build, discover, try, and consume APIs in your Azure API Center. Get started today!

 

 

Version history
Last update:
‎Jun 05 2024 03:53 PM