java_backend_template_api_client
v0.0.2
Published
Rest_API_based_on_java_which_provides_readwritedeletesearch_operations_for_JBT_project
Downloads
7
Readme
java_backend_template_api_client
JavaBackendTemplateApi - JavaScript client for java_backend_template_api_client Rest API based on java which provides read/write/delete/search operations for JBT project This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.1
- Package version: 0.0.1
- Build package: io.swagger.codegen.v3.generators.javascript.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 java_backend_template_api_client --save
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):
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 JavaBackendTemplateApi = require('java_backend_template_api_client');
var api = new JavaBackendTemplateApi.CreateOrderTagApi()
var body = new JavaBackendTemplateApi.CreateOrderRequest(); // {CreateOrderRequest}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createOrder(body, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:{port}/
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- JavaBackendTemplateApi.CreateOrderTagApi | createOrder | POST /api/v1/orders/createOrder | Create new order JavaBackendTemplateApi.GetApi | getWithParameters | GET /api/v1/queryTest | Return String JavaBackendTemplateApi.HealthcheckApi | statuscode | GET /api/v1/healthcheck/statuscode | Endpoint for healthcheck JavaBackendTemplateApi.LoginApi | login | POST /api/v1/login | Logging in JavaBackendTemplateApi.OrdersTagApi | getAllOrders | GET /api/v1/orders | Get all orders JavaBackendTemplateApi.ProductsTagApi | getAllProducts | GET /api/v1/products | Get all products JavaBackendTemplateApi.ProfileApi | getUserInfo | GET /api/v1/userInfo/{username} | Get user information JavaBackendTemplateApi.RegressionTestApi | testGet | GET /api/v1/regressionTest/testGet | Test get JavaBackendTemplateApi.RegressionTestApi | testGetBadRequest | GET /api/v1/regressionTest/testGetBadRequest | Test get bad request JavaBackendTemplateApi.RegressionTestApi | testPost | POST /api/v1/regressionTest/testPost | Test post JavaBackendTemplateApi.StubTestTagApi | stubTestEndpointGet | GET /api/v1/stubTest/stubTestEndpoint | stubTestEndpointGet JavaBackendTemplateApi.TokenApi | refresh | POST /api/v1/token/refresh | Refresh access token JavaBackendTemplateApi.TreeComparatorApi | compareConditions | GET /api/v1/treeComparator/getConditions | Condition comparator test JavaBackendTemplateApi.TreeComparatorApi | compareMultiplePatterns | GET /api/v1/treeComparator/multiplePatterns | Compare multiple p() JavaBackendTemplateApi.TreeGetApi | treeGet | GET /api/v1/treeComparator/tree | Tree Test get JavaBackendTemplateApi.UserOrdersTagApi | getUserOrders | GET /api/v1/orders/byUserId/{userId} | Get user orders JavaBackendTemplateApi.VarTestApi | varTestGet | POST /api/v1/varTest/varTestPost | Var Test get
Documentation for Models
- JavaBackendTemplateApi.ConditionsInResponse
- JavaBackendTemplateApi.CreateOrderRequest
- JavaBackendTemplateApi.CreateOrderResponse
- JavaBackendTemplateApi.DebugInfo
- JavaBackendTemplateApi.ErrorBody
- JavaBackendTemplateApi.GenericApiResponseCreateOrderResponse
- JavaBackendTemplateApi.GenericApiResponseGetWithParametersResponse
- JavaBackendTemplateApi.GenericApiResponseJwtTokensResponse
- JavaBackendTemplateApi.GenericApiResponseListConditionsInResponse
- JavaBackendTemplateApi.GenericApiResponseListMultiplePatternsInResponse
- JavaBackendTemplateApi.GenericApiResponseListOrderResponse
- JavaBackendTemplateApi.GenericApiResponseListProductResponse
- JavaBackendTemplateApi.GenericApiResponseListRegressionTestListResponse
- JavaBackendTemplateApi.GenericApiResponseListVarTestListResponse
- JavaBackendTemplateApi.GenericApiResponseProfileResponse
- JavaBackendTemplateApi.GenericApiResponseRegressionTestPostResponse
- JavaBackendTemplateApi.GenericApiResponseStubTestResponse
- JavaBackendTemplateApi.GenericApiResponseTreeGetResponse
- JavaBackendTemplateApi.GenericApiResponseVoid
- JavaBackendTemplateApi.GetWithParametersResponse
- JavaBackendTemplateApi.JwtTokensResponse
- JavaBackendTemplateApi.LoginRequest
- JavaBackendTemplateApi.MultiplePatternsInResponse
- JavaBackendTemplateApi.OrderEntryRequest
- JavaBackendTemplateApi.OrderEntryResponse
- JavaBackendTemplateApi.OrderResponse
- JavaBackendTemplateApi.ProductResponse
- JavaBackendTemplateApi.ProfileResponse
- JavaBackendTemplateApi.RefreshTokenRequest
- JavaBackendTemplateApi.RegressionTestListResponse
- JavaBackendTemplateApi.RegressionTestPostRequest
- JavaBackendTemplateApi.RegressionTestPostResponse
- JavaBackendTemplateApi.StubTestResponse
- JavaBackendTemplateApi.TreeGetResponse
- JavaBackendTemplateApi.VarTestListResponse
- JavaBackendTemplateApi.VarTestRequest