twc_rest_client
v1.0.0
Published
ERROR_UNKNOWN
Downloads
3
Readme
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.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 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/YOUR_USERNAME/swagger-js-client then install it via:
npm install YOUR_USERNAME/swagger-js-client --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 someId = "someId_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.getHtmlServiceProvider(someId, callback);
Documentation for API Endpoints
All URIs are relative to https://localhost:8443/det-twc-am-adapter/services/
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- SwaggerJsClient.DefaultApi | getHtmlServiceProvider | GET /catalog/{someId} | SwaggerJsClient.DefaultApi | getHtmlServiceProvider1 | GET /serviceProviders/{projectId} | SwaggerJsClient.DefaultApi | getResourceAsHtml | GET /api/{projectId}/{branchId}/Resource/{id} | SwaggerJsClient.DefaultApi | getResourceAsHtmlLargePreview | GET /api/{projectId}/{branchId}/Resource/{id}/largePreview | SwaggerJsClient.DefaultApi | getResourceAsHtmlSmallPreview | GET /api/{projectId}/{branchId}/Resource/{id}/smallPreview | SwaggerJsClient.DefaultApi | getResourceShapeAsHtml | GET /resourceShapes/{resourceShapePath} | SwaggerJsClient.DefaultApi | getRootServices | GET /rootservices | SwaggerJsClient.DefaultApi | getServiceProviderCatalog | GET /catalog/{serviceProviderCatalogId} | SwaggerJsClient.DefaultApi | getServiceProviderCatalogs | GET /catalog | SwaggerJsClient.DefaultApi | getServiceProviders | GET /serviceProviders | SwaggerJsClient.DefaultApi | queryResourcesAsHtml | GET /serviceProviders/{projectId}/resources | SwaggerJsClient.DefaultApi | reportPerformance | GET /api/performance |
Documentation for Models
- SwaggerJsClient.Compact
- SwaggerJsClient.CreationFactory
- SwaggerJsClient.Dialog
- SwaggerJsClient.Link
- SwaggerJsClient.OAuthConfiguration
- SwaggerJsClient.PrefixDefinition
- SwaggerJsClient.Preview
- SwaggerJsClient.Property
- SwaggerJsClient.Publisher
- SwaggerJsClient.QueryCapability
- SwaggerJsClient.Resource
- SwaggerJsClient.ResourceShape
- SwaggerJsClient.Service
- SwaggerJsClient.ServiceProvider
- SwaggerJsClient.ServiceProviderCatalog
Documentation for Authorization
All endpoints do not require authorization.