APIVerve.API.RandomPun 1.1.2

Random Pun API

Random Pun is a simple tool for getting random puns. It returns a random pun from a collection of puns.

This is a .NET Wrapper for the Random Pun API

Installation

Using the .NET CLI:

dotnet add package APIVerve.API.RandomPun

Using the Package Manager:

nuget install APIVerve.API.RandomPun

Using the Package Manager Console:

Install-Package APIVerve.API.RandomPun

From within Visual Studio:

1. Open the Solution Explorer.
2. Right-click on a project within your solution.
3. Click on Manage NuGet Packages...
4. Click on the Browse tab and search for "APIVerve.API.RandomPun".
5. Click on the APIVerve.API.RandomPun package, select the appropriate version in the right-tab and click Install.

Configuration

Before using the randompun API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com

Usage

The Random Pun API documentation is found here: https://docs.apiverve.com/api/randompun.
You can find parameters, example responses, and status codes documented here.

Setup

Authentication

Random Pun API uses API Key-based authentication. When you create an instance of the API client, you can pass your API Key as a parameter.

// Create an instance of the API client
var apiClient = new RandomPunAPIClient("[YOUR_API_KEY]", true);

Perform Request

Using the API client, you can perform requests to the API.

Define Query

This API does not require a Query

Simple Request

var response = apiClient.Execute();
if(response.error != null) {
	Console.WriteLine(response.error);
} else {
    var jsonResponse = JsonConvert.SerializeObject(response, Newtonsoft.Json.Formatting.Indented);
    Console.WriteLine(jsonResponse);
}

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "category": "Heaven and Hell",
    "rating": 4,
    "pun": "The Reverend Francis Norton woke up Sunday morning and realizing it was an exceptionally beautiful and sunny early spring day, decided he just had to play golf. So... he told the Associate Pastor that he was feeling sick and convinced him to say Mass for him that day.As soon as the Associate Pastor left the room, Father Norton headed out of town to a golf course about forty miles away. This way he knew he wouldn't accidentally meet anyone he knew from his parish. Setting up on the first tee, he was alone. After all, it was Sunday morning and everyone else was in church!At about this time, Saint Peter leaned over to the Lord while looking down from the heavens and exclaimed, 'You're not going to let him get away with this, are you?'The Lord sighed, and said, 'No, I guess not.'Just then Father Norton hit the ball and it shot straight towards the pin, dropping just short of it, rolled up and fell into the hole. It WAS A 420 YARD HOLE IN ONE!St. Peter was astonished. He looked at the Lord and asked, 'Why did you let him do that?'The Lord smiled and replied, 'Who's he going to tell?'"
  }
}

Customer Support

Need any assistance? Get in touch with Customer Support.

Updates

Stay up to date by following @apiverveHQ on Twitter.

Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.

License

Licensed under the The MIT License (MIT)

Copyright (©) 2024 APIVerve, and Evlar LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.