weather_forecast_api
v1.0.0
Published
This_is_the_swagger_definition_of_the_weather_forecast_API__For_more_info_contact_sdimopoulosirisweb_gr
Downloads
3
Readme
weather_forecast_api
WeatherForecastApi - JavaScript client for weather_forecast_api This is the swagger definition of the weather forecast API. For more info contact [email protected] This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.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 weather_forecast_api --save
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
Finally, switch to the directory you want to use your weather_forecast_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('weather_forecast_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/weather_forecast_api then install it via:
npm install YOUR_USERNAME/weather_forecast_api --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, that's to say your javascript file where you actually
use this library):
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 WeatherForecastApi = require('weather_forecast_api');
var defaultClient = WeatherForecastApi.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"
var api = new WeatherForecastApi.CityApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAllCityInfo(callback);
Documentation for API Endpoints
All URIs are relative to https://forecast-api.irisweb.gr/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- WeatherForecastApi.CityApi | getAllCityInfo | GET /city | Get a list of all cities WeatherForecastApi.CityApi | getCityInfo | GET /city/{cityId} | Find city by ID
Documentation for Models
- WeatherForecastApi.ApiResponse
- WeatherForecastApi.City
- WeatherForecastApi.CityCoords
- WeatherForecastApi.ForecastInfo
- WeatherForecastApi.ForecastInfoHumidity
- WeatherForecastApi.ForecastInfoPressure
- WeatherForecastApi.ForecastInfoTemperature
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: token
- Location: HTTP header