libreccm/ccm-apiclient-commons
Jens Pelzetter df9b53680c Some more doc 2020-07-12 12:16:59 +02:00
..
src/main/typescript Cleanup of structure, documentation 2020-07-12 12:04:59 +02:00
.eslintrc.js Started implementation of API client for ccm-core 2020-07-10 20:48:01 +02:00
.gitignore Started implementation of API client for ccm-core 2020-07-10 20:48:01 +02:00
README.md Some more doc 2020-07-12 12:16:59 +02:00
package-lock.json Current status of ccm-apiclient-commons. Trying to figure best way for zero dependencies and supporting browsers and node environments 2020-07-11 18:14:09 +02:00
package.json Current status of ccm-apiclient-commons. Trying to figure best way for zero dependencies and supporting browsers and node environments 2020-07-11 18:14:09 +02:00
pom.xml Started implementation of API client for ccm-core 2020-07-10 20:48:01 +02:00
tsconfig.json Started implementation of API client for ccm-core 2020-07-10 20:48:01 +02:00

README.md

LibreCCM API Client Commons

This module provides several usaable parts of building clients for specific endpoints of the LibreCCM RESTful API.

The entities module provides several entities used by various endpoints of the RESTful API of LibreCCM.

The module also provides an HTTP client specially tailored for the RESTful API of LibreCCM. The client is provided in several implementations: For browsers, for node.js and an isomorphic implementation. In most cases you will want to use the isomorphic implementation.

For most use cases it is recommanded to use the specific client APIs provided by the LibreCCM modules which provided a more high-level interface to the RESTful API of LibreCCM.