AlexSt153 / REST-Sample-TS

Sample project to show possible wrapper on DocuWare REST API with Typescript and Node.js

DocuWare REST API Sample

This example is written by DocuWare. Feel free to fork and play around. We do not recommend to use this example for productive purposes. It's more like to show a possible way to use our DocuWare REST API.

Project was created with DocuWare 7.1

Prerequisites

Be familiar with Nodejs, Typescript and Promises:

• Nodejs
• Typescript Tooling in 5 Minutes
• Promises

We've developed this project with Visual Studio Code.

Project structure

Startup: index.ts Javascript output dir: ./dist The REST Wrapper class

Custom typescript definition files

• "types/DW_Rest.d" Wrappes the REST Schema here, so you can work with interfaces in code
• "types/DW_Request_Promise_Extension.d" Just a helper to work with node module 'request-promise'
• "types/timespan.d" Definition for module 'timespan' so you can work better in typescript

How to start

1. Install node packages (run 'npm install')
2. Take a look in "index.ts" and restWrapper.ts
3. Change credentials, organization and root URL
4. Play around, find the functions you need
5. Compile the code so it can be run (npm run tsc)
6. Run the code (npm run start)
7. In case of changing code, do not forget to rerun typescript compile(manually or by watcher)

Typedoc project reference documentation

Project References

More information

Feel free and take also a look on https://developer.docuware.com