swagger-js-client-mirden v1.0.3
swagger-js-client
SwaggerJsClient - JavaScript client for swagger-js-client No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.2
- Package version: 1.0.2
- 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 swagger-js-client --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 swagger-js-client from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('swagger-js-client')
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/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --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 SwaggerJsClient = require('swagger-js-client');
var api = new SwaggerJsClient.DefaultApi()
var opts = {
'name': "name_example", // {String} name of the city GML
'countryName': "countryName_example", // {String} the name of the country which the city is in (in the user's language)
'file': "/path/to/file.txt" // {File} The CityGML file (FileUpload)
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.addCity(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:8080/server/rest/v1
Class | Method | HTTP request | Description |
---|---|---|---|
SwaggerJsClient.DefaultApi | addCity | POST /cities | Add a city |
SwaggerJsClient.DefaultApi | addPoI | POST /cities/{cityId}/POIs | Create a POI |
SwaggerJsClient.DefaultApi | cityDetails | GET /cities/{cityId} | Gets city details for a specific city |
SwaggerJsClient.DefaultApi | deleteCity | DELETE /cities/{cityId} | Deletes a city |
SwaggerJsClient.DefaultApi | deletePoI | DELETE /cities/{cityId}/POIs/{poiId} | Deletes a POI |
SwaggerJsClient.DefaultApi | getAllActiveCities | GET /cities | Gets all (active) cities |
SwaggerJsClient.DefaultApi | getSpecificPoiOfCity | GET /cities/{cityId}/POIs | POIs in a city, optionally filtered |
SwaggerJsClient.DefaultApi | getSunnyTimesInPoi | GET /cities/{cityId}/POIs/{poiId}/SunnyTimes | Get sunnytime of a specific POI |
SwaggerJsClient.DefaultApi | getSunnyTimesOfAllPoi | GET /cities/{cityId}/POIs/Sunny | Get all POI in the sun during a specific time |
SwaggerJsClient.DefaultApi | updateCity | PUT /cities/{cityId} | Updates CityGML Model |
SwaggerJsClient.DefaultApi | updatePoI | PUT /cities/{cityId}/POIs/{poiId} | Update a POI |
Documentation for Models
- SwaggerJsClient.CityModel
- SwaggerJsClient.Link
- SwaggerJsClient.POIResource
- SwaggerJsClient.PoIParameter
- SwaggerJsClient.Point
- SwaggerJsClient.PointOfInterest
- SwaggerJsClient.Polygon
- SwaggerJsClient.SunnyTime
Documentation for Authorization
All endpoints do not require authorization.
6 years ago