worldnewsapi

1.3.2 • Public • Published

worldnewsapi

Worldnewsapi - JavaScript client for worldnewsapi The world's news wrapped into a single API. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.3.2
  • Package version: 1.3.2
  • Generator version: 7.8.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install worldnewsapi --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your worldnewsapi from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/ddsky/world-news-api-clients/tree/main/javascript/ then install it via:

    npm install ddsky/world-news-api-clients/tree/main/javascript/ --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Worldnewsapi = require('worldnewsapi');

var defaultClient = Worldnewsapi.ApiClient.instance;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['api-key'] = "Token"
// Configure API key authorization: headerApiKey
var headerApiKey = defaultClient.authentications['headerApiKey'];
headerApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//headerApiKey.apiKeyPrefix['x-api-key'] = "Token"

var api = new Worldnewsapi.NewsApi()
var url = "https://www.bbc.com/news/world-us-canada-59340789"; // {String} The url of the news.
var analyze = true; // {Boolean} Whether to analyze the news (extract entities etc.)
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.extractNews(url, analyze, callback);

Documentation for API Endpoints

All URIs are relative to https://api.worldnewsapi.com

Class Method HTTP request Description
Worldnewsapi.NewsApi extractNews GET /extract-news Extract News
Worldnewsapi.NewsApi extractNewsLinks GET /extract-news-links Extract News Links
Worldnewsapi.NewsApi getGeoCoordinates GET /geo-coordinates Get Geo Coordinates
Worldnewsapi.NewsApi newsWebsiteToRSSFeed GET /feed.rss News Website to RSS Feed
Worldnewsapi.NewsApi retrieveNewsArticlesByIds GET /retrieve-news Retrieve News Articles by Ids
Worldnewsapi.NewsApi retrieveNewspaperFrontPage GET /retrieve-front-page Retrieve Newspaper Front Page
Worldnewsapi.NewsApi searchNews GET /search-news Search News
Worldnewsapi.NewsApi topNews GET /top-news Top News

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apiKey

  • Type: API key
  • API key parameter name: api-key
  • Location: URL query string

headerApiKey

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Readme

Keywords

none

Package Sidebar

Install

npm i worldnewsapi

Weekly Downloads

5

Version

1.3.2

License

Unlicense

Unpacked Size

162 kB

Total Files

19

Last publish

Collaborators

  • ddsky