Edit on Github

Generate REST API clients

The DotVVM Command Line tool can also be used to add and update REST API bindings clients.

Even though the DotVVM CLI requires .NET Core, it can be used also for .NET Framework projects with OWIN since it is not a runtime component. It is used only on the developer machines.

Supported commands

Task Syntax Options
Add API Client dotnet dotvvm api create
  • {SwaggerJsonUrl} - URL of the Swagger JSON metadata
  • {Namespace} - namespace in which the API clients will be declared
  • {CSharpClientPath} - relative path to the generate C# client file
  • {TypescriptClientPath} - relative path to the generate TypeScript client file
Update API Client dotnet dotvvm api regen
  • {SwaggerJsonUrl} - (optional) URL of the Swagger JSON metadata; if not specified, all clients will be regenerated

The metadata of REST API Bindings are stored in dotvvm.json file. If any of the parameters needs to be updated, you can change them in this file.

Please note that the API client needs to be registered in DotvvmStartup.cs. See REST API bindings chapter for more details.

Examples

  1. Registering the API client:
dotnet dotvvm api create http://localhost:43852/swagger/v1/swagger.json DotVVM2.Demo.RestApi.Api Api/ApiClient.cs wwwroot/Scripts/ApiClient.ts
  1. Updating the generated clients:
dotnet dotvvm api regen

See also

Information about cookies

We use cookies to analyze our traffic, personalize content and ads, and to provide some social media features. We also share information about your use of our site with our social media, advertising and analytics partners who may combine it with other information that you've provided to them or that they've collected from your use of their services.

Edit options

Information about cookies

We use cookies to analyze our traffic, personalize content and ads, and to provide some social media features. We also share information about your use of our site with our social media, advertising and analytics partners who may combine it with other information that you've provided to them or that they've collected from your use of their services.

Choose which cookies you want to enable

Necessary cookies Always allowed

Necessary cookies are essential and maintain information based on your activity on our site, like remembering your signed in account, selection of your language, or products added to the shopping cart. The website cannot work properly without these cookies.

Google Analytics

We use these cookies to measure, collect, analyse and report how users interact with our sites to better understand their behavior. Thanks to this, we can improve the site and provide better experience. The analytics service is provided by Google Inc.

Google Ads

We use these cookies to measure conversions from our advertisement and banners distributed via Google Ads. This allows us to better target the ads and make them more relevant to you.

Facebook Pixel

We use these cookies to measure conversions from our advertisement and banners distributed via Facebook. This allows us to better target the ads and make them more relevant to you.

Smartlook

We use these cookies to measure, collect, analyse and report how users interact with our sites to better understand their behavior. Thanks to this, we can improve the site and provide better experience. The analytics service is provided by Smartlook.

Google ads user data

Google ads ad personalization