LibreCCM
/
libreccm
3
0
Fork 0
Code Issues 10 Pull Requests Packages Releases Wiki Activity

Some more doc

Jens Pelzetter 2020-07-12 12:16:59 +02:00
parent 917961a570
commit df9b53680c
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
ccm-apiclient-commons/README.md
View File

@ -1,5 +1,17 @@
LibreCCM API Client Commons
===========================
This module provides basic classes for building clients for the RESTful APIs
provided by modules of LibreCCM. Details can be found in the documentation.
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.