Virto Commerce builds a swagger schema for every module automatically.
Using swagger schema, you can quickly generate a Client for .NET, ASP.NET Core and TypeScript to communicate it easily with the existing VC Platform.
We recommend using NSwag. NSwag is a Swagger/OpenAPI 2.0 and 3.0 toolchain for .NET, .NET Core, Web API, ASP.NET Core, TypeScript (jQuery, AngularJS, Angular 2+, Aurelia, KnockoutJS and more) and other platforms, written in C#.
To generate the TypeScript Client with NSwag Studio
- Download NSwag Studio and install it.
- Start NSwag Studio and download
./vc-open-api.nswagprofile. - Type swagger schema endpoint. Ex: http://localhost:10645/docs/VirtoCommerce.MarketplaceVendor/swagger.json
- Hit the “Generate Outputs” button and copy the output and save