Wiki.Net 4.1.0

Wiki.Net

Wiki.Net – An unofficial .NET Wikipedia API wrapper.

Features

Searches Wikipedia (duh!) in multiple defined languages and returns (per result):

• Title
• Page ID
• Word Count
• Size (bytes?)
• Text Preview
• URL of page
• Time of last edit

Getting Started

Installation

You can install via NuGet by adding Wiki.Net to your project's packages:

<ItemGroup>
    <PackageReference Include="Wiki.Net" Version="4.1.0"/>
</ItemGroup>

Example

string searchString = "Computer";
WikiSearcher searcher = new();
WikiSearchSettings searchSettings = new() {RequestId = "Request ID", ResultLimit = 5, ResultOffset = 2, Language = "en"};

WikiSearchResponse response = searcher.Search(searchString, searchSettings);

Console.WriteLine($"\nResults found ({searchString}):\n");
foreach (WikiSearchResult result in response.Query.SearchResults)
{
	Console.WriteLine(
                $"\t{result.Title} ({result.WordCount} words, {result.Size} bytes, id {result.PageId}):\t{result.Preview}...\n\tAt {result.Url.AbsoluteUri} and {result.ConstantUrl.AbsoluteUri}\n\tLast edited at {result.LastEdited}\n");
}

Console.ReadLine();

Output

Results found (Computer):

        Computer engineering (2533 words, 28125 bytes, id 50408):       Computer engineering (CoE or CpE) is a branch of electrical engineering that integrates several fields of computer science and electronic engineering required...
        At https://en.wikipedia.org/wiki/Computer engineering and https://en.wikipedia.org/?curid=50408
        Last edited at 27/6/2022 3:37:42 pm

        Computer science (6930 words, 72988 bytes, id 5323):    Fundamental areas of computer science Computer science is the study of computation, automation, and information. Computer science spans theoretical disciplines...
        At https://en.wikipedia.org/wiki/Computer science and https://en.wikipedia.org/?curid=5323
        Last edited at 3/7/2022 3:18:56 am

        Computer animation (4609 words, 40388 bytes, id 6777):  Computer animation is the process used for digitally generating animated images. The more general term computer-generated imagery (CGI) encompasses both...
        At https://en.wikipedia.org/wiki/Computer animation and https://en.wikipedia.org/?curid=6777
        Last edited at 16/6/2022 4:26:51 pm

        *More results*

Upgrading

From 3.x to 4.x

In 4.0, we changed WikiSearcher from being static, to a class that you must instantiate first. We made this change so that your program's global HttpClient may be passed through.

To upgrade, first instantiate WikiSearcher, then call Search(string searchString, WikiSearchSettings? searchSettings = null) with the newly created WikiSearcher.

The methods in WikiSearchResult for getting the URLs have also been removed, and replaced with properties. The language will have already been set to what you provided in WikiSearchSettings.

HTTP support was also dropped, you now MUST use HTTPS.

From 2.x to 3.x

In 3.0, we simplified the namespace of Wiki.Net to WikiDotNet.

To upgrade from 2.x version of Wiki.Net to 3.x, you need to change all of the using CreepysinStudios.WikiDotNet to using WikiDotNet in your projects. The easiest way would just be to do a replace all in your entire solution.

Authors

Ararem (Formally EternalClickbait) - Initial work - Ararem

Voltstro - Current Maintainer / Initial Docs Writer - Voltstro

License

This project is licensed under the MIT license – see the LICENSE.md file for details.