https://github.com/datvm/digitalbibleplatformsharp

A wrapper for API call to Digital Bible Platform
https://github.com/datvm/digitalbibleplatformsharp

Last synced: 2 months ago
JSON representation

A wrapper for API call to Digital Bible Platform

• Host: GitHub
• URL: https://github.com/datvm/digitalbibleplatformsharp
• Owner: datvm
• License: mit
• Created: 2018-03-17T09:23:29.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-17T14:57:32.000Z (about 7 years ago)
• Last Synced: 2025-02-14T15:16:32.461Z (4 months ago)
• Language: C#
• Size: 51.8 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE.MD

Awesome Lists containing this project

README

        
A wrapper API call to the Developer API of [Digital Bible Platform](https://www.digitalbibleplatform.com/).

# Usage

Example API call:

    // apiKey is your API Key

    var service = new DigitalBiblePlatformService(apiKey);

    var result = await this.service.LanguageListingAsync(new LanguageListingRequest()

    {

        Name = "Vietnamese",

    });

Consult [Test Project](https://github.com/datvm/DigitalBiblePlatformSharp/tree/master/DigitalBiblePlatformSharp.Test) for more use cases.

# Test Project

Since Private API Key is needed for calling API and I cannot just ignore Config file, Environment Variable is the best place to put in the key for testing.

Before running the test, please set a Environment Variable `DBPSharpApiKey` with your API Key (remember to restart Visual Studio because Environment Variables are only read at program startup.

In TestUtils file I have also defined a compiler variable:

        #define WRITELOGFILE

    

to enable writing log files to:

        public const string LogFileLocation = @"D:\Temp\TestLog";

        

Remove/Change the variable to disable JSON responses files writing.