https://github.com/krtirtho/wikipedia_api
Wikipedia API generated using OpenApi Specification for Dart and Flutter
https://github.com/krtirtho/wikipedia_api
dart flutter wikipedia wikipedia-api
Last synced: about 1 year ago
JSON representation
Wikipedia API generated using OpenApi Specification for Dart and Flutter
- Host: GitHub
- URL: https://github.com/krtirtho/wikipedia_api
- Owner: KRTirtho
- License: mit
- Created: 2023-11-22T13:54:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-22T14:38:00.000Z (over 2 years ago)
- Last Synced: 2024-10-19T04:08:20.917Z (over 1 year ago)
- Topics: dart, flutter, wikipedia, wikipedia-api
- Language: Dart
- Homepage: https://en.wikipedia.org/api/rest_v1/#/
- Size: 104 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Wikipedia API (Generated using [OpenAPI Generators][generator-link])
This API provides cacheable and straightforward access to Wikimedia content and data, in machine-readable formats.
### Global Rules
- Limit your clients to no more than 200 requests/s to this API.
Each API endpoint's documentation may detail more specific usage limits.
- Set a unique `User-Agent` or `Api-User-Agent` header that
allows us to contact you quickly. Email addresses or URLs
of contact pages work well.
By using this API, you agree to Wikimedia's [Terms of Use](https://wikimediafoundation.org/wiki/Terms_of_Use) and [Privacy Policy](https://wikimediafoundation.org/wiki/Privacy_policy). Unless otherwise specified in the endpoint documentation below, content accessed via this API is licensed under the [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) and [GFDL](https://www.gnu.org/copyleft/fdl.html) licenses, and you irrevocably agree to release modifications or additions made through this API under these licenses. See https://www.mediawiki.org/wiki/REST_API for background and details.
### Endpoint documentation
Please consult each endpoint's documentation for details on:
- Licensing information for the specific type of content
and data served via the endpoint.
- Stability markers to inform you about development status and
change policy, according to
[our API version policy](https://www.mediawiki.org/wiki/API_versioning).
- Endpoint specific usage limits.
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Build package: org.openapitools.codegen.languages.DartClientCodegen
For more information, please visit [http://mediawiki.org/wiki/REST_API](http://mediawiki.org/wiki/REST_API)
## Requirements
Dart 2.12 or later
## Installation & Usage
Run the following to install:
```shell
$ flutter pub add wikipedia_api
```
## Tests
TODO
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```dart
import 'package:wikipedia_api/api.dart';
final api_instance = CitationApi();
final format = format_example; // String | The format to use for the resulting citation data
final query = query_example; // String | URL of an article, DOI, PMCID or PMID in the URL-encoded format. Note that on the Swagger-UI doc page you don't need to URI-encode the parameter manually, it will be done by the docs engine.
final acceptLanguage = acceptLanguage_example; // String | For some articles the result depends on the `Accept-Language` header, so provide it if localized content is required.
try {
final result = api_instance.getCitation(format, query, acceptLanguage);
print(result);
} catch (e) {
print('Exception when calling CitationApi->getCitation: $e\n');
}
```
## Documentation for API Endpoints
All URIs are relative to */api/rest_v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CitationApi* | [**getCitation**](doc//CitationApi.md#getcitation) | **GET** /data/citation/{format}/{query} | Get citation data given an article identifier.
*FeedApi* | [**aggregatedFeed**](doc//FeedApi.md#aggregatedfeed) | **GET** /feed/featured/{yyyy}/{mm}/{dd} | Aggregated featured content
*FeedApi* | [**feedAnnouncementsGet**](doc//FeedApi.md#feedannouncementsget) | **GET** /feed/announcements | Current announcements to display
*FeedApi* | [**onThisDay**](doc//FeedApi.md#onthisday) | **GET** /feed/onthisday/{type}/{mm}/{dd} | Events on this day
*MathApi* | [**mediaMathCheckTypePost**](doc//MathApi.md#mediamathchecktypepost) | **POST** /media/math/check/{type} | Check and normalize a TeX formula.
*MathApi* | [**mediaMathFormulaHashGet**](doc//MathApi.md#mediamathformulahashget) | **GET** /media/math/formula/{hash} | Get a previously-stored formula
*MathApi* | [**mediaMathRenderFormatHashGet**](doc//MathApi.md#mediamathrenderformathashget) | **GET** /media/math/render/{format}/{hash} | Get rendered formula in the given format.
*MobileApi* | [**dataCssMobileTypeGet**](doc//MobileApi.md#datacssmobiletypeget) | **GET** /data/css/mobile/{type} | Get CSS for mobile apps.
*MobileApi* | [**dataI18nTypeGet**](doc//MobileApi.md#datai18ntypeget) | **GET** /data/i18n/{type} | Get internationalization info
*MobileApi* | [**dataJavascriptMobileTypeGet**](doc//MobileApi.md#datajavascriptmobiletypeget) | **GET** /data/javascript/mobile/{type} | Get JavaScript for mobileapps
*MobileApi* | [**getSections**](doc//MobileApi.md#getsections) | **GET** /page/mobile-sections/{title} | Get mobile-optimized HTML sections for a title.
*MobileApi* | [**getSectionsLead**](doc//MobileApi.md#getsectionslead) | **GET** /page/mobile-sections-lead/{title} | Get mobile-optimized HTML lead section and metadata for a title.
*MobileApi* | [**getSectionsLeadWithRevision**](doc//MobileApi.md#getsectionsleadwithrevision) | **GET** /page/mobile-sections-lead/{title}/{revision} | Get mobile-optimized HTML lead section and metadata for a title.
*MobileApi* | [**getSectionsRemaining**](doc//MobileApi.md#getsectionsremaining) | **GET** /page/mobile-sections-remaining/{title} | Get non-lead mobile-optimized HTML sections for a title.
*MobileApi* | [**getSectionsRemainingWithRevision**](doc//MobileApi.md#getsectionsremainingwithrevision) | **GET** /page/mobile-sections-remaining/{title}/{revision} | Get non-lead mobile-optimized HTML sections for a title.
*MobileApi* | [**getSectionsWithRevision**](doc//MobileApi.md#getsectionswithrevision) | **GET** /page/mobile-sections/{title}/{revision} | Get mobile-optimized HTML sections for a title.
*OfflineApi* | [**pageMobileHtmlOfflineResourcesTitleGet**](doc//OfflineApi.md#pagemobilehtmlofflineresourcestitleget) | **GET** /page/mobile-html-offline-resources/{title} | Get styles and scripts for offline consumption of mobile-html-formatted pages
*OfflineApi* | [**pageMobileHtmlOfflineResourcesTitleRevisionGet**](doc//OfflineApi.md#pagemobilehtmlofflineresourcestitlerevisionget) | **GET** /page/mobile-html-offline-resources/{title}/{revision} | Get styles and scripts for offline consumption of mobile-html-formatted pages
*PageContentApi* | [**getContentMediaList**](doc//PageContentApi.md#getcontentmedialist) | **GET** /page/media-list/{title} | Get list of media files used on a page.
*PageContentApi* | [**getContentMobileHtml**](doc//PageContentApi.md#getcontentmobilehtml) | **GET** /page/mobile-html/{title} | Get page content HTML optimized for mobile consumption.
*PageContentApi* | [**getContentWithRevisionMediaList**](doc//PageContentApi.md#getcontentwithrevisionmedialist) | **GET** /page/media-list/{title}/{revision} | Get list of media files used on a page.
*PageContentApi* | [**getContentWithRevisionMobileHtml**](doc//PageContentApi.md#getcontentwithrevisionmobilehtml) | **GET** /page/mobile-html/{title}/{revision} | Get page content HTML optimized for mobile consumption.
*PageContentApi* | [**getFormatRevision**](doc//PageContentApi.md#getformatrevision) | **GET** /page/html/{title}/{revision} | Get HTML for a specific title/revision & optionally timeuuid.
*PageContentApi* | [**getRelatedPages**](doc//PageContentApi.md#getrelatedpages) | **GET** /page/related/{title} | Get pages related to the given title
*PageContentApi* | [**pageDataParsoidTitleRevisionTidGet**](doc//PageContentApi.md#pagedataparsoidtitlerevisiontidget) | **GET** /page/data-parsoid/{title}/{revision}/{tid} | Get data-parsoid metadata for a specific title/revision/tid.
*PageContentApi* | [**pageGet**](doc//PageContentApi.md#pageget) | **GET** /page/ | List page-related API entry points.
*PageContentApi* | [**pageHtmlTitleGet**](doc//PageContentApi.md#pagehtmltitleget) | **GET** /page/html/{title} | Get latest HTML for a title.
*PageContentApi* | [**pageLintTitleGet**](doc//PageContentApi.md#pagelinttitleget) | **GET** /page/lint/{title} | Get the linter errors for a specific title/revision.
*PageContentApi* | [**pageLintTitleRevisionGet**](doc//PageContentApi.md#pagelinttitlerevisionget) | **GET** /page/lint/{title}/{revision} | Get the linter errors for a specific title/revision.
*PageContentApi* | [**pageMobileHtmlOfflineResourcesTitleGet**](doc//PageContentApi.md#pagemobilehtmlofflineresourcestitleget) | **GET** /page/mobile-html-offline-resources/{title} | Get styles and scripts for offline consumption of mobile-html-formatted pages
*PageContentApi* | [**pageMobileHtmlOfflineResourcesTitleRevisionGet**](doc//PageContentApi.md#pagemobilehtmlofflineresourcestitlerevisionget) | **GET** /page/mobile-html-offline-resources/{title}/{revision} | Get styles and scripts for offline consumption of mobile-html-formatted pages
*PageContentApi* | [**pagePdfTitleFormatGet**](doc//PageContentApi.md#pagepdftitleformatget) | **GET** /page/pdf/{title}/{format} | Get a page as PDF
*PageContentApi* | [**pagePdfTitleFormatTypeGet**](doc//PageContentApi.md#pagepdftitleformattypeget) | **GET** /page/pdf/{title}/{format}/{type} | Get a page as PDF
*PageContentApi* | [**pagePdfTitleGet**](doc//PageContentApi.md#pagepdftitleget) | **GET** /page/pdf/{title} | Get a page as PDF
*PageContentApi* | [**pageRandomFormatGet**](doc//PageContentApi.md#pagerandomformatget) | **GET** /page/random/{format} | Get content for a random page
*PageContentApi* | [**pageSegmentsTitleGet**](doc//PageContentApi.md#pagesegmentstitleget) | **GET** /page/segments/{title} | Fetches a segmented page to be used in machine translation
*PageContentApi* | [**pageSegmentsTitleRevisionGet**](doc//PageContentApi.md#pagesegmentstitlerevisionget) | **GET** /page/segments/{title}/{revision} | Fetches a segmented page to be used in machine translation
*PageContentApi* | [**pageSummaryTitleGet**](doc//PageContentApi.md#pagesummarytitleget) | **GET** /page/summary/{title} | Get basic metadata and simplified article introduction.
*PageContentApi* | [**pageTitleTitleGet**](doc//PageContentApi.md#pagetitletitleget) | **GET** /page/title/{title} | Get revision metadata for a title.
*PageContentApi* | [**pageTitleTitleRevisionGet**](doc//PageContentApi.md#pagetitletitlerevisionget) | **GET** /page/title/{title}/{revision} | Get revision metadata for a title.
*ReadingListsApi* | [**dataListsBatchPost**](doc//ReadingListsApi.md#datalistsbatchpost) | **POST** /data/lists/batch | Create multiple new lists for the current user.
*ReadingListsApi* | [**dataListsChangesSinceDateGet**](doc//ReadingListsApi.md#datalistschangessincedateget) | **GET** /data/lists/changes/since/{date} | Get recent changes to the lists
*ReadingListsApi* | [**dataListsGet**](doc//ReadingListsApi.md#datalistsget) | **GET** /data/lists/ | Get all lists of the current user.
*ReadingListsApi* | [**dataListsIdDelete**](doc//ReadingListsApi.md#datalistsiddelete) | **DELETE** /data/lists/{id} | Delete a list.
*ReadingListsApi* | [**dataListsIdEntriesBatchPost**](doc//ReadingListsApi.md#datalistsidentriesbatchpost) | **POST** /data/lists/{id}/entries/batch | Create multiple new list entries.
*ReadingListsApi* | [**dataListsIdEntriesEntryIdDelete**](doc//ReadingListsApi.md#datalistsidentriesentryiddelete) | **DELETE** /data/lists/{id}/entries/{entry_id} | Delete a list entry.
*ReadingListsApi* | [**dataListsIdEntriesPost**](doc//ReadingListsApi.md#datalistsidentriespost) | **POST** /data/lists/{id}/entries/ | Create a new list entry.
*ReadingListsApi* | [**dataListsIdPut**](doc//ReadingListsApi.md#datalistsidput) | **PUT** /data/lists/{id} | Update a list.
*ReadingListsApi* | [**dataListsPagesProjectTitleGet**](doc//ReadingListsApi.md#datalistspagesprojecttitleget) | **GET** /data/lists/pages/{project}/{title} | Get lists of the current user which contain a given page.
*ReadingListsApi* | [**dataListsPost**](doc//ReadingListsApi.md#datalistspost) | **POST** /data/lists/ | Create a new list for the current user.
*ReadingListsApi* | [**dataListsSetupPost**](doc//ReadingListsApi.md#datalistssetuppost) | **POST** /data/lists/setup | Opt in to use reading lists.
*ReadingListsApi* | [**dataListsTeardownPost**](doc//ReadingListsApi.md#dataliststeardownpost) | **POST** /data/lists/teardown | Opt out from using reading lists.
*ReadingListsApi* | [**getListEntries**](doc//ReadingListsApi.md#getlistentries) | **GET** /data/lists/{id}/entries/ | Get all entries of a given list.
*RecommendationApi* | [**dataRecommendationArticleCreationMorelikeSeedArticleGet**](doc//RecommendationApi.md#datarecommendationarticlecreationmorelikeseedarticleget) | **GET** /data/recommendation/article/creation/morelike/{seed_article} | Recommend missing articles
*RecommendationApi* | [**dataRecommendationArticleCreationTranslationFromLangGet**](doc//RecommendationApi.md#datarecommendationarticlecreationtranslationfromlangget) | **GET** /data/recommendation/article/creation/translation/{from_lang} | Recommend articles for translation.
*RecommendationApi* | [**dataRecommendationArticleCreationTranslationFromLangSeedArticleGet**](doc//RecommendationApi.md#datarecommendationarticlecreationtranslationfromlangseedarticleget) | **GET** /data/recommendation/article/creation/translation/{from_lang}/{seed_article} | Recommend articles for translation.
*TalkPagesApi* | [**pageTalkTitleGet**](doc//TalkPagesApi.md#pagetalktitleget) | **GET** /page/talk/{title} | Get structured talk page contents
*TalkPagesApi* | [**pageTalkTitleRevisionGet**](doc//TalkPagesApi.md#pagetalktitlerevisionget) | **GET** /page/talk/{title}/{revision} | Get structured talk page contents
*TransformsApi* | [**doDict**](doc//TransformsApi.md#dodict) | **GET** /transform/word/from/{from}/{word} | Fetch the dictionary meaning of a word
*TransformsApi* | [**doDictProvider**](doc//TransformsApi.md#dodictprovider) | **GET** /transform/word/from/{from}/{word}/{provider} | Fetch the dictionary meaning of a word
*TransformsApi* | [**doMT**](doc//TransformsApi.md#domt) | **POST** /transform/html/from/{from} | Machine-translate content
*TransformsApi* | [**doMTProvider**](doc//TransformsApi.md#domtprovider) | **POST** /transform/html/from/{from}/{provider} | Machine-translate content
*TransformsApi* | [**transformHtmlToWikitextPost**](doc//TransformsApi.md#transformhtmltowikitextpost) | **POST** /transform/html/to/wikitext | Transform HTML to Wikitext
*TransformsApi* | [**transformHtmlToWikitextTitlePost**](doc//TransformsApi.md#transformhtmltowikitexttitlepost) | **POST** /transform/html/to/wikitext/{title} | Transform HTML to Wikitext
*TransformsApi* | [**transformHtmlToWikitextTitleRevisionPost**](doc//TransformsApi.md#transformhtmltowikitexttitlerevisionpost) | **POST** /transform/html/to/wikitext/{title}/{revision} | Transform HTML to Wikitext
*TransformsApi* | [**transformWikitextToHtmlPost**](doc//TransformsApi.md#transformwikitexttohtmlpost) | **POST** /transform/wikitext/to/html | Transform Wikitext to HTML
*TransformsApi* | [**transformWikitextToHtmlTitlePost**](doc//TransformsApi.md#transformwikitexttohtmltitlepost) | **POST** /transform/wikitext/to/html/{title} | Transform Wikitext to HTML
*TransformsApi* | [**transformWikitextToHtmlTitleRevisionPost**](doc//TransformsApi.md#transformwikitexttohtmltitlerevisionpost) | **POST** /transform/wikitext/to/html/{title}/{revision} | Transform Wikitext to HTML
*TransformsApi* | [**transformWikitextToLintPost**](doc//TransformsApi.md#transformwikitexttolintpost) | **POST** /transform/wikitext/to/lint | Check Wikitext for lint errors
*TransformsApi* | [**transformWikitextToLintTitlePost**](doc//TransformsApi.md#transformwikitexttolinttitlepost) | **POST** /transform/wikitext/to/lint/{title} | Check Wikitext for lint errors
*TransformsApi* | [**transformWikitextToLintTitleRevisionPost**](doc//TransformsApi.md#transformwikitexttolinttitlerevisionpost) | **POST** /transform/wikitext/to/lint/{title}/{revision} | Check Wikitext for lint errors
*TransformsApi* | [**transformWikitextToMobileHtml**](doc//TransformsApi.md#transformwikitexttomobilehtml) | **POST** /transform/wikitext/to/mobile-html/{title} | Transform Wikitext to Mobile HTML
## Documentation For Models
- [Action](doc//Action.md)
- [Announcement](doc//Announcement.md)
- [AnnouncementsResponse](doc//AnnouncementsResponse.md)
- [Batch](doc//Batch.md)
- [CxDict](doc//CxDict.md)
- [CxDictTranslationsInner](doc//CxDictTranslationsInner.md)
- [CxMt](doc//CxMt.md)
- [DataListsGet200Response](doc//DataListsGet200Response.md)
- [DataListsIdEntriesBatchPost200Response](doc//DataListsIdEntriesBatchPost200Response.md)
- [DataListsIdEntriesBatchPost200ResponseBatchInner](doc//DataListsIdEntriesBatchPost200ResponseBatchInner.md)
- [DataListsIdEntriesBatchPostRequest](doc//DataListsIdEntriesBatchPostRequest.md)
- [DataListsIdEntriesPost200Response](doc//DataListsIdEntriesPost200Response.md)
- [DataListsPagesProjectTitleGet200Response](doc//DataListsPagesProjectTitleGet200Response.md)
- [DataListsPost200Response](doc//DataListsPost200Response.md)
- [DataParsoid](doc//DataParsoid.md)
- [Feed](doc//Feed.md)
- [GetListEntries200Response](doc//GetListEntries200Response.md)
- [Image](doc//Image.md)
- [ImageDescription](doc//ImageDescription.md)
- [ListCreateBatch](doc//ListCreateBatch.md)
- [ListEntryRead](doc//ListEntryRead.md)
- [ListEntryWrite](doc//ListEntryWrite.md)
- [ListId](doc//ListId.md)
- [ListRead](doc//ListRead.md)
- [ListWrite](doc//ListWrite.md)
- [Listing](doc//Listing.md)
- [ListingLinks](doc//ListingLinks.md)
- [ListingLinksNext](doc//ListingLinksNext.md)
- [MediaItem](doc//MediaItem.md)
- [MediaItemCaption](doc//MediaItemCaption.md)
- [MediaItemOriginal](doc//MediaItemOriginal.md)
- [MediaList](doc//MediaList.md)
- [MorelikeResultInner](doc//MorelikeResultInner.md)
- [Mostread](doc//Mostread.md)
- [MostreadArticle](doc//MostreadArticle.md)
- [NewsItem](doc//NewsItem.md)
- [OnthisdayInner](doc//OnthisdayInner.md)
- [OnthisdayResponse](doc//OnthisdayResponse.md)
- [Originalimage](doc//Originalimage.md)
- [PageSegmentsTitleGet200Response](doc//PageSegmentsTitleGet200Response.md)
- [Problem](doc//Problem.md)
- [RecommendationResult](doc//RecommendationResult.md)
- [RecommendationResultItemsInner](doc//RecommendationResultItemsInner.md)
- [Related](doc//Related.md)
- [Result](doc//Result.md)
- [Revision](doc//Revision.md)
- [RevisionIdentifier](doc//RevisionIdentifier.md)
- [RevisionInfo](doc//RevisionInfo.md)
- [Revisions](doc//Revisions.md)
- [Summary](doc//Summary.md)
- [SummaryCoordinates](doc//SummaryCoordinates.md)
- [Thumbnail](doc//Thumbnail.md)
- [TitlesSet](doc//TitlesSet.md)
- [TransformWikitextToLintPostRequest](doc//TransformWikitextToLintPostRequest.md)
## Documentation For Authorization
Endpoints do not require authorization.
## Library Author
Kingkor Roy Tirtho
[generator-link]: https://openapi-generator.tech/