Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tom-weatherhead/observable-json-rest-api-client
Send HTTP requests (POST, GET, PUT, and DELETE) to JSON REST Web services or other Web servers. Responses are packaged as RxJS Observables.
https://github.com/tom-weatherhead/observable-json-rest-api-client
Last synced: about 6 hours ago
JSON representation
Send HTTP requests (POST, GET, PUT, and DELETE) to JSON REST Web services or other Web servers. Responses are packaged as RxJS Observables.
- Host: GitHub
- URL: https://github.com/tom-weatherhead/observable-json-rest-api-client
- Owner: tom-weatherhead
- License: mit
- Created: 2018-03-02T04:49:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:04:54.000Z (almost 2 years ago)
- Last Synced: 2024-11-13T22:25:05.545Z (3 days ago)
- Language: JavaScript
- Homepage:
- Size: 312 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# observable-json-rest-api-client
Send HTTP requests to JSON REST Web services; receive responses as RxJS Observables.
[](https://travis-ci.org/tom-weatherhead/common-utilities.js)
[](https://www.npmjs.com/package/observable-json-rest-api-client)
[](https://www.npmjs.com/package/observable-json-rest-api-client)
[](https://codeclimate.com/github/tom-weatherhead/common-utilities.js/maintainability)
[](https://snyk.io/test/github/tom-weatherhead/common-utilities.js?targetFile=package.json&package-lock.json)
[](https://github.com/tom-weatherhead/observable-json-rest-api-client/blob/master/LICENSE)
This package can send HTTP requests of type POST, GET, PUT, and DELETE; these types correspond to the CRUD operations (create, read, update, and delete) of a REST Web service. Any data sent is JSON, and attempts are made to parse any data received as JSON.
This package's API is:
```
request(httpMethod, urlString, requestData, verbose = false)
post(urlString, requestData, verbose = false)
get(urlString, verbose = false)
put(urlString, requestData, verbose = false)
delete(urlString, verbose = false)
```
post(), get(), put(), and delete() are merely convenience functions that call request() with a specific httpMethod.
Each function returns an [RxJS Observable](http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html) that yields an object with the following fields:
- statusCode : The HTTP status code from the response from the server
- statusMessage : The HTTP status message from the response from the server
- rawResponseBody : The raw body from the response from the server
- jsonResponseBody : The body from the response from the server after it has been parsed as JSON. This field is only present if the response body was successfully parsed as JSON.
- jsonParseError : The error, if any, that was encountered during the parsing of the response body as JSON.
Example 1: POST:
```js
const engine = require('observable-json-rest-api-client');
const postData = {
field1: 'abc',
field2: 123
};
engine.post('https://httpbin.org/post', postData).subscribe(
result => {
console.log('POST: Result:', result);
console.log('POST: Response body as JSON:', result.jsonResponseBody);
console.log('POST: Posted data:', result.jsonResponseBody.data);
},
error => {
console.error('POST: Error:', error);
},
() => {
console.log('POST: Done.');
}
);
```
Example 2: GET:
```js
const engine = require('observable-json-rest-api-client');
engine.get('https://httpbin.org/uuid').subscribe(
result => {
console.log('GET: result:', result);
console.log(`GET: HTTP response status: ${result.statusCode} ${result.statusMessage}`);
console.log('GET: Response body as JSON:', result.jsonResponseBody);
console.log('GET: UUID:', result.jsonResponseBody.uuid);
console.log('GET: typeof UUID:', typeof result.jsonResponseBody.uuid);
},
error => {
console.error('GET: Error:', error);
},
() => {
console.log('GET: Done.');
}
);
```
## License
[MIT](https://choosealicense.com/licenses/mit/)