apiNG-plugin-wikipedia is a wikipedia API plugin for apiNG.
Information
- Supported apiNG models:
social
- This plugin supports the
get-native-data
parameter - Used promise library: angular-wikipedia-api-factory (included in distribution files)
Documentation
- INSTALLATION
- Get file
- Include file
- Add dependency
- Add plugin
- USAGE
- Models
- Requests
1. INSTALLATION
I. Get file
Install via either bower, npm, CDN (jsDelivr) or downloaded files:
bower install apiNG-plugin-wikipedia --save
npm install aping-plugin-wikipedia --save
- use CDN file
- download apiNG-plugin-wikipedia.zip
II. Include file
Include aping-plugin-wikipedia.min.js
in your apiNG application
<!-- when using bower --> <!-- when using npm --> <!-- when using cdn file --> <!-- when using downloaded files -->
III. Add dependency
Add the module jtt_aping_wikipedia
as a dependency to your app module:
angular;
IV. Add the plugin
Add the plugin's directive aping-wikipedia="[]"
to your apiNG directive and configure your requests
2. USAGE
I. Models
Supported apiNG models
model | content | support | max items per request |
(native) default items per request |
---|---|---|---|---|
social |
articles | full | 500 |
10 |
support:
- full: the source platform provides a full list with usable results
- partly: the source platfrom provides just partly usable results
II. Requests
Every apiNG plugin expects an array of requests as html attribute.
Get Article by Name
parameter | sample | default | description | optional |
---|---|---|---|---|
title |
Association football |
Existing wikipedia page | no | |
language |
de |
en |
Shorthandle of existing wikipedia project | yes |
Sample requests:
[{'title':'International System of Units'}, {'title':'Metrication in the United States'}]
[{'title':'Metrologie', 'language':'de'}]
Search Articles
parameter | sample | default | description | optional |
---|---|---|---|---|
search |
soccer |
Text to search | no | |
textSearch |
true |
false |
Search in title and content | yes |
items |
25 |
10 |
Items per request (0 -500 ) |
yes |
language |
de |
en |
Shorthandle of existing wikipedia project | yes |
Sample requests:
[{'search':'fc bayern'}, {'search':'read madrid'}]
[{'search':'ozean', 'textSearch':'true', 'items':20, 'language':'de' }]
Licence
MIT