angular-wikipedia-api-factory

angular-wikipedia-api-factory is an angularjs module with a wikipedia api factory.

Author: Jonathan Hornung (JohnnyTheTank)

Usage

• Install via either bower, npm or downloaded files:

  • bower install --save angular-wikipedia-api-factory
  • npm install --save angular-wikipedia-api-factory
  • download angular-wikipedia-api-factory.zip

• Include dependencies in your HTML.

  • When using bower:

  <script src="bower_components/angular-wikipedia-api-factory/dist/angular-wikipedia-api-factory.min.js"></script>
  

  • When using npm:

  <script src="node_modules/angular-wikipedia-api-factory/dist/angular-wikipedia-api-factory.min.js"></script>
  

  • when using downloaded files

  <script src="angular-wikipedia-api-factory.min.js"></script>
  

• Add jtt_wikipedia to your application's module dependencies

  angular.module('app', ['jtt_wikipedia']);
  

• Use the factory wikipediaFactory

  angular.module('app')
      .controller('appController', function($scope, wikipediaFactory){
      
          wikipediaFactory.getArticle({
              term: 'Oktoberfest'
          }).then(function (_data) {
              //on success
          });
          
      });
  

factory methods

searchArticles

wikipediaFactory.searchArticles({
    term: '<TERM>', // Searchterm
    lang: '<LANGUAGE>', // (optional) default: 'en'
    gsrlimit: '<GS_LIMIT>', // (optional) default: 10. valid values: 0-500
    pithumbsize: '<PAGE_IMAGES_THUMBNAIL_SIZE>', // (optional) default: 400
    pilimit: '<PAGE_IMAGES_LIMIT>', // (optional) 'max': images for all articles, otherwise only for the first
    exlimit: '<EX_LIMIT>', // (optional) 'max': extracts for all articles, otherwise only for the first
    exintro: '<EX_INTRO>', // (optional) '1': if we just want the intro, otherwise it shows all sections
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

wikipediaFactory.searchArticlesByTitle({
    term: '<TERM>', // Searchterm
    lang: '<LANGUAGE>', // (optional) default: 'en'
    gsrlimit: '<GS_LIMIT>', // (optional) default: 10. valid values: 0-500
    pithumbsize: '<PAGE_IMAGES_THUMBNAIL_SIZE>', // (optional) default: 400
    pilimit: '<PAGE_IMAGES_LIMIT>', // (optional) 'max': images for all articles, otherwise only for the first
    exlimit: '<EX_LIMIT>', // (optional) 'max': extracts for all articles, otherwise only for the first
    exintro: '<EX_INTRO>', // (optional) '1': if we just want the intro, otherwise it shows all sections
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

getArticle

wikipediaFactory.getArticle({
    term: '<TERM>', // Searchterm
    lang: '<LANGUAGE>', // (optional) default: 'en'
    pithumbsize: '<PAGE_IMAGE_THUMBNAIL_SIZE>', // (optional) default: '400'
}).then(function (_data) {
    //on success
}).catch(function (_data) {
    //on error
});

Wikipedia JSONP API

• Documentation: https://www.mediawiki.org/wiki/API:Main_page/en
• API Sandbox: https://www.mediawiki.org/wiki/Special:ApiSandbox

More angular-api-factories

bandsintown - dailymotion - facebook - flickr - footballdata - github - openweathermap - tumblr - vimeo - wikipedia - youtube

License

MIT