Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iwannabebot/sharpwiki
A tiny C# api client for Wikipedia
https://github.com/iwannabebot/sharpwiki
mediawiki mediawiki-api wiki wikipedia wikipedia-api
Last synced: about 1 month ago
JSON representation
A tiny C# api client for Wikipedia
- Host: GitHub
- URL: https://github.com/iwannabebot/sharpwiki
- Owner: iwannabebot
- License: mit
- Created: 2023-01-11T14:51:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-13T12:49:39.000Z (about 2 years ago)
- Last Synced: 2024-12-19T05:43:40.796Z (about 1 month ago)
- Topics: mediawiki, mediawiki-api, wiki, wikipedia, wikipedia-api
- Language: C#
- Homepage:
- Size: 64.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SharpWiki
A tiny C# api client for Wikipedia
#### Install from Nuget
[](https://www.nuget.org/packages/SharpWiki/)
```pwsh
Install-Package SharpWiki
```
### Status
### Supported APIs
|Support|Resource|Operation|
|-------|--------|----------|
|✅|Search|Page|
|✅|Search|Title|
|✅|Page|Create|
|✅|Page|Update|
|✅|Page|Get|
|✅|Page|Get Offline|
|✅|Page|Get Source|
|✅|Page|Get HTML|
|✅|Page|Get Languages|
|✅|Page|Get Files|
|✅|Media|Get|
|❌|History|Get Page History|
|❌|History|Get Page History Counts|
|❌|History|Get Revision|
|❌|History|Compare Revisions|
#### Quick Start
This client will use English wikipedia's API. To change settings use `SharpWikiClientOptions` and pass the parameter in `SharpWikiClient`
```cs
// Initialize SharpWikiClient
using SharpWikiClient client= new SharpWikiClient();
// Search page
// This will search entire wikipedia page
WikiSearch searchPages = await client.SearchPagesAsync("Jupiter", 5);
foreach(WikiSearchPage page in searchPages.Pages)
{
Console.WriteLine($"{page.Id}");
Console.WriteLine($"{page.Title}");
Console.WriteLine($"{page.Description}");
Console.WriteLine($"{page.Thumbnail.Url}");
}
// Search title
// This will search wikipedia titles only
// A good use case is to use this for autocomplete
WikiSearch searchTitles = await client.SearchTitleAsync("Jupiter", 5);
foreach (WikiSearchPage page in searchTitles.Pages)
{
Console.WriteLine($"{page.Id}");
Console.WriteLine($"{page.Title}");
}
```
##### Get Page
```cs
// Get a wiki page by title
WikiPage page= await client.GetPageAsync("Jupiter");
Console.WriteLine($"{page.Id}");
Console.WriteLine($"{page.Title}");
Console.WriteLine($"{page.HtmlUrl}");
// Get a wiki page by title with html
WikiPage offlinePage = await client.GetPageOfflineAsync("Jupiter");
Console.WriteLine($"{offlinePage.Id}");
Console.WriteLine($"{offlinePage.Title}");
Console.WriteLine($"{offlinePage.Html}");
// Get a wiki page by title with original source
// Read more about source types from https://www.mediawiki.org/wiki/Content_handlers
WikiPage sourcePage = await client.GetPageSourceAsync("Jupiter");
Console.WriteLine($"{offlinePage.Id}");
Console.WriteLine($"{offlinePage.Title}");
Console.WriteLine($"{offlinePage.Source}");
// Get a wiki page by title as HTML
string wikiPageHtml = await client.GetPageHtmlAsync("Jupiter");
Console.WriteLine($"{wikiPageHtml}");
```
##### Get Page in all languages
```cs
// Get list of languages in which this title is also present
IEnumerable pageLanguages = await client.GetPageLanguagesAsync("Jupiter");
foreach(WikiPageLanguage pageLanguage in pageLanguages)
{
Console.WriteLine($"{pageLanguage.Name}");
Console.WriteLine($"{pageLanguage.Code}");
Console.WriteLine($"{pageLanguage.Title}");
Console.WriteLine($"{pageLanguage.Key}");
}
```
##### Get Files on Page
```cs
// Get list of files present on a wiki page
IEnumerable filesOnPage = await client.GetFilesOnPageAsync("Jupiter");
foreach (WikiFile fileOnPage in filesOnPage)
{
Console.WriteLine($"{fileOnPage.Title}");
Console.WriteLine($"{fileOnPage.Original.Url}");
}
```
##### Create a Page
```cs
// Create a wiki page
WikiPageRequestCreate createWikiModel = new WikiPageRequestCreate
{
Title = "My Wiki Page",
Comment = "This is a test page",
// core types :wikitext, text, json, javascript, css
// For more types refer https://www.mediawiki.org/wiki/Content_handlers
ContentModel = "text",
Source = "This is test wiki page content"
};
WikiPage createdPage = await client.CreatePageAsync(createWikiModel);
```
##### Update a Page
```cs
// Update a wiki page
WikiPageRequestUpdate updateWikiModel = new WikiPageRequestUpdate
{
Comment = "This is a test page",
// core types :wikitext, text, json, javascript, css
// For more types refer https://www.mediawiki.org/wiki/Content_handlers
ContentModel = "text",
Source = "This is updated wiki page content",
Latest = new WikiPageRevision
{
Id = 100
}
};
WikiPage updatedPage = await client.UpdatePageAsync("My Wiki Page", updateWikiModel);
```
##### Get File
```cs
// Get a file by name
WikiFile file = await client.GetFileAsync("filename");
```
##### Want to use IHttpClientFactory?
```cs
SharpWikiClient client= new SharpWikiClient(clientOptions, httpClientFactory);
```
##### Want to use other languages?
You can set `Language` in `SharpWikiClientOptions` and pass into SharpWikiClient to change a language
```cs
var clientOptions = new SharpWikiClientOptions
{
ApiUserAgent = "SharpWiki.Tests", // Write name of you app
Language = WikiLanguage.Spanish, // Choose wikipedia language
GetToken = () =>
{
// Get Mediawiki token (required to create or update page only)
// For more details, refer: https://www.mediawiki.org/wiki/Extension:OAuth
return "";
}
};
SharpWikiClient client= new SharpWikiClient(clientOptions);
```