Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.42 KB

CodeGen.md

File metadata and controls

64 lines (41 loc) · 2.42 KB
Raw

OpenAPI C# Model Code Generation

We use C# model code generated from OpenAPI files describing UK Open Banking APIs.

OpenAPI file sources

OpenAPI files for UK Open Banking Read/Write Data APIs may be obtained here: https://github.com/OpenBankingUK/read-write-api-specs. Tags are used to denote releases.

OpenAPI files for UK Open Banking Dynamic Client Registration APIs may be obtained here: https://github.com/OpenBankingUK/client-registration-api-specs. Tags are used to denote releases.

Code Generation

We use OpenAPI Generator to generate C# model code from OpenAPI files.

Installing OpenAPI Generator

It is suggested to install OpenAPI Generator locally as online versions have proved unreliable. See latest installation instructions.

Example install command (PowerShell):

Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar

You may need to install Java (e.g. OpenJDK) to enable it to run.

Generation of API Model Code

Please refer to the full usage notes for OpenAPI Generator.

For a given API, we auto-generate a client then extract the model code.

Examples

Below is example code for generating model C# for a given API. After running this code we can copy the contents of the Model directory into a project in OpenBankingConnector.

Client Registration API model Generation

$specVersion = "ClientRegistration.V3p2"
$specFile = "C:\Repos\OBUK.client-registration-api-specs\dist\client-registration-openapi.yaml"
mkdir $specVersion
java.exe -jar openapi-generator-cli.jar generate `
-g csharp-netcore `
-i $specFile `
-p "packageName=OpenBanking.Library.Connector.ObModels.$specVersion,netCoreProjectFile=true,targetFramework=netstandard2.1,useDateTimeOffset=true" `
-o ./$specVersion

Payment Initiation API model generation:

$specVersion = "PaymentInitiation.V3p1p1"
$specFile = "C:\Repos\OBUK.read-write-api-specs\dist\payment-initiation-openapi.yaml"
mkdir $specVersion
java.exe -jar openapi-generator-cli.jar generate `
-g csharp-netcore `
-i $specFile `
-p "packageName=OpenBanking.Library.Connector.ObModels.$specVersion,netCoreProjectFile=true,targetFramework=netstandard2.1,useDateTimeOffset=true" `
-o ./$specVersion