abstract-http-service v0.0.2
Abstract HTTP Service for Angular
This package is intended to make setup for basic HTTP requests quicker and easier.
AbstractHttpService
AbstractHttpService is the only service in this package. There are two abstract properties a get property 'baseUrl' and 'path', and five public methods to use.
Abstract Properties
baseUrl:
It would be recommended to have another abstract service extend this service, and return a baseUrl from your environment.ts to allow for easier deployment. To setup environment variables in your angular project go to Angular Build Guide.
path:
This should be set in each of the services that derive from this abstract service. This represents the controller that you want to hit endpoints on with this service. If you don't put / at the end of your baseUrl, you will need to precede your path with /.
Public Functions
All public functions return an abservable of any type that can be subscribed to.
post:
| Argument Name | Type | Description | Nullable |
|---|---|---|---|
| pathSegments | any[] | Adds path segment to request url | False |
| body | any | Model to send to endpoint | False |
| queryParameters | Map<string, any> | adds keys and values to request url as query parameters | True |
put:
| Argument Name | Type | Description | Nullable |
|---|---|---|---|
| pathSegments | any[] | Adds path segment to request url | False |
| body | any | Model to send to endpoint | False |
patch:
| Argument Name | Type | Description | Nullable |
|---|---|---|---|
| pathSegments | any[] | Adds path segment to request url | False |
| body | any | Model to send to endpoint | False |
get:
| Argument Name | Type | Description | Nullable |
|---|---|---|---|
| pathSegments | any[] | Adds path segment to request url | False |
| queryParameters | Map<string, any> | adds keys and values to request url as query parameters | False |
delete:
| Argument Name | Type | Description | Nullable |
|---|---|---|---|
| pathSegments | any[] | Adds path segment to request url | False |
| body | any | Model to send to endpoint | True |
| queryParameters | Map<string, any> | adds keys and values to request url as query parameters | True |