@otr-app/shared-backend-generated-client
v2.4.45
Published
Generate client-side and service-side code using swagger CLI
Downloads
1,985
Keywords
Readme
Import
In your app.js, inject the otrBackendService module
angular.module("otr-console", [
'ngAnimate',
'ngCookies',
'ngStorage',
'ngRetina',
...
'otrBackendService'
]);
Instantiation
- Inject OtrService into your controller/bizLogic
- Create an OtrService variable in the scope of the controller/bizLogic
- You can inject the domain via constructor injection.
...
var otrService = new OtrService({domain: ENV.apiEndpoint})
...
Usage
- The methods generated in the OtrService component are the java methodName + "Using" + httpMethod
- E.g. getCaseUsingGET, confirmBookingUsingPOST, and etc...
let responseSuccess = await otrService.getCaseUsingGET({caseId: caseId});
Error Handling
- Sample Code
try {
await otrService.getCaseUsingGET({caseId: caseId})
} catch(error) {
const uiErrorMsg = error.body.error.uiErrorMsg;
}
How to upgrade the generated AngularJS client
- Make sure you are authenticated with npm under the @otr-app organization
npm login --scope=@otr-app
- Generate the JSON models and endpoints from devo
npm run generate:devo
- OR generate the JSON models and endpoints from local server
npm run generate:local
- OR generate the JSON models and endpoints from local server
- Optional: Sanity check the differences in otrBackendService.js
git diff HEAD dist/otrBackendService.js
- Update version number in package.json
npm version patch
- Commit the changes and push to github
- Execute
npm publish
- Done.