README

Plinth.HttpApiClient

HTTP Api Client framework built on MS HttpClient

Adds logging and tracing to HttpClient based API clients.

There are two supported approaches to building clients, autogenerated clients and manually built clients.

Auto generating clients with nswag

• install nodejs at least 12+
• npm install -g nswag
• run this powershell, substituting the link to the swagger spec

$targetServiceSwaggerUrl = "{url or path to openapi spec}" $targetServiceName = "{client class name}" $namespace = "{client namespace}" $nswagParams = @( 'openapi2csclient', '/runtime:net100', # Use net100, net90, or net80 depending on your target framework "/input:\`"${targetServiceSwaggerUrl}\`"", "/classname:${targetServiceName}Client", "/namespace:${namespace}", "/output:${targetServiceName}Client.cs", '/operationGenerationMode:SingleClientFromOperationId', '/generateClientInterfaces:true', '/injectHttpClient:true', '/useBaseUrl:false', '/disposeHttpClient:false', '/generateOptionalParameters:true' '/exceptionClass:NSwagException', '/generateExceptionClasses:true', '/parameterDateTimeFormat:o', '/generateNullableReferenceTypes:true', '/excludedParameterNames:X-Plinth-Auth' ) nswag @nswagParams | Out-Host

• Documentation for configuration options: https://github.com/RicoSuter/NSwag/wiki/NSwag-Configuration-Document

• Also available using `nswag help openapi2csclient

• Register the client during Startup

services.AddHttpApiHandlerClient<INSwagClient, NSwagClient>( "NSwagClient", configureClient: c => { c.BaseAddress = new Uri("http://localhost:5000"); });

Manually building clients

Build a manual api client by deriving from BaseHttpApiClient and implementing API methods using extensions. Example below: