custom header signature testing
The generated code uses the Newtonsoft Json.NET NuGet Package. If the automatic NuGet package restore is enabled, these dependencies will be installed automatically. Therefore, you will need internet access for build.
"This library requires Visual Studio 2017 for compilation."
- Open the solution (CustomHeaderSignature.sln) file.
- Invoke the build process using
Ctrl+Shift+Bshortcut key or using theBuildmenu as shown below.
The build process generates a portable class library, which can be used like a normal class library. The generated library is compatible with Windows Forms, Windows RT, Windows Phone 8, Silverlight 5, Xamarin iOS, Xamarin Android and Mono. More information on how to use can be found at the MSDN Portable Class Libraries documentation.
The following section explains how to use the CustomHeaderSignature library in a new console project.
For starting a new project, right click on the current solution from the solution explorer and choose Add -> New Project.
Next, choose "Console Application", provide a TestConsoleProject as the project name and click OK.
The new console project is the entry point for the eventual execution. This requires us to set the TestConsoleProject as the start-up project. To do this, right-click on the TestConsoleProject and choose Set as StartUp Project form the context menu.
In order to use the CustomHeaderSignature library in the new project, first we must add a projet reference to the TestConsoleProject. First, right click on the References node in the solution explorer and click Add Reference....
Next, a window will be displayed where we must set the checkbox on CustomHeaderSignature.Standard and click OK. By doing this, we have added a reference of the CustomHeaderSignature.Standard project into the new TestConsoleProject.
Once the TestConsoleProject is created, a file named Program.cs will be visible in the solution explorer with an empty Main method. This is the entry point for the execution of the entire solution.
Here, you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.
The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.
In order to setup authentication and initialization of the API client, you need the following information.
| Parameter | Description |
|---|---|
| token | TODO: add a description |
API client can be initialized as following.
// Configuration parameters and credentials
string token = "token";
CustomHeaderSignatureClient client = new CustomHeaderSignatureClient(token);
The singleton instance of the CustomHeaderSignatureController class can be accessed from the API Client.
CustomHeaderSignatureController customHeaderSignature = client.CustomHeaderSignature;
TODO: Add a method description
Task<string> GetCustomHeaderSignature()string result = await customHeaderSignature.GetCustomHeaderSignature();