Nobly.OnBaseRestApiClient
1.3.11
See the version list below for details.
dotnet add package Nobly.OnBaseRestApiClient --version 1.3.11
NuGet\Install-Package Nobly.OnBaseRestApiClient -Version 1.3.11
<PackageReference Include="Nobly.OnBaseRestApiClient" Version="1.3.11" />
paket add Nobly.OnBaseRestApiClient --version 1.3.11
#r "nuget: Nobly.OnBaseRestApiClient, 1.3.11"
// Install Nobly.OnBaseRestApiClient as a Cake Addin #addin nuget:?package=Nobly.OnBaseRestApiClient&version=1.3.11 // Install Nobly.OnBaseRestApiClient as a Cake Tool #tool nuget:?package=Nobly.OnBaseRestApiClient&version=1.3.11
To generate a new ApiClient:
- Install NSwagStudio.
- Double-click
\OnBaseRestApiClient\NoblyOnBaseRestApiClient\generate client.nswag
to open it in NSwagStudio (Use NSwag v13.20.0.0 - v14.x.x.x client won't build!). - Fire up OnBaseRestApi and go to its swagger page.
- Copy the
https://localhost:{port}/openapi/v1/openapi.json
URL. - Paste this URL into
Inputs->Specification URL
and clickCreate local copy
. - Click CTRL+S to save
generate client.nswag
file. - In
Output->CSharpClient->Settings->Output file path
, write the output path, e.g.,C:\repro\OnBaseRestApiClient\NoblyOnBaseRestApiClient\ApiClient.cs
. - Click
Outputs->Generate Outputs
for a preview, and thenGenerate Files
in order to save the generated API client to file.
Important note:
Client methods are susceptible to change since NSwag will only include the HTTP method in client names when there is a name conflict, e.g., if there is a GET and a POST method with the same route.
So, if there is no signature conflict for a method and another endpoint is added with the same signature but a different HTTP method, the original client method name will change, i.e., it will subsequently include the HTTP method in its client method name.
E.g. if only a GET
method exists for the endpoint Document
, this would generate a DocumentAsync
client method, but if a POST
method with the same route were added, the DocumentAsync
client method name would change to DocumentGetAsync
.
This means that method signatures in a newly generated client should always be compared to the ones in the existing client to detect whether any client method signatures have changed.
Changed method signatures will need to be modified accordingly in any consuming code.
v.1.3.8:
- Method name
ApiDocumentsNotesAsync
changed toApiDocumentsNotesGetAsync
. - Method name
ApiDocumentsHistoryAsync
changed toApiDocumentsHistoryGetAsync
.
v.1.3.9:
- Added method
ApiWorkViewSqlObjectsWorkViewsAsync
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Newtonsoft.Json (>= 12.0.3)
- System.ComponentModel.Annotations (>= 4.7.0)
- System.Runtime.Serialization.Primitives (>= 4.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.3.14 | 90 | 10/29/2024 |
1.3.13 | 120 | 9/3/2024 |
1.3.11 | 122 | 5/21/2024 |
1.3.10 | 96 | 5/16/2024 |
1.3.9 | 84 | 5/16/2024 |
1.3.8 | 161 | 3/21/2024 |
1.3.6 | 466 | 1/4/2024 |
1.3.3 | 427 | 12/12/2023 |
1.3.2 | 410 | 12/12/2023 |
1.3.1 | 412 | 12/11/2023 |
1.3.0 | 419 | 12/7/2023 |
1.2.10 | 1,405 | 2/2/2022 |
1.2.7 | 3,603 | 8/24/2020 |
1.2.6 | 1,062 | 8/21/2020 |
1.2.5 | 999 | 8/18/2020 |
1.2.4 | 1,097 | 8/18/2020 |
1.2.3 | 1,074 | 8/13/2020 |
1.2.2 | 1,323 | 6/26/2020 |
1.2.1 | 1,089 | 6/26/2020 |
1.2.0 | 1,103 | 6/26/2020 |
1.1.0 | 1,088 | 6/19/2020 |
1.0.1 | 1,111 | 6/19/2020 |
1.0.0 | 1,124 | 6/19/2020 |