GitLab

First is important to know the concept of the api client. In the module an api client and an api resource is two different things.

API Client: An api client is, for us, the part which will make the http request and return the result with no treatment.

API Resource: An api resource, for us, is the part which will prepare the http request by generating the url (end point), prepare the parameters (query/body) and after got the api result, will cast the api result into the desired type.

How to use

1. You need to get an API client. In our structure, API clients are injectable services, so to get an instance of one of the API client you have to do this:

...

constructor(
private api : ChoucasAPI,
){...}

...

2. After you get your API client, you have to create a resource. That resource will allow you to get data. To create a resource, proceed as below:

let resource : OperationResource = new OperationResource(this.api);

3. You can use the resource as you want (according the API documentation). For example to get all operations you just need do resource.get().

Note: A resource method always returns a Promise or a boolean. Every HTTP method return a Promise except the DELETE method which returns a boolean.

How to add a client

Create an API Client

1. Create a new class as below:

@Injectable({
    providedIn: 'root'
})
class MyNewAPI extends  API.API {

    constructor(
        private httpClient : HttpClient // This is required
        // Add all parameters you need
    ){
        super(
            httpClient,
            "your/base/url"
            // There is a third parameter: You can add a custom HttpHeaders
        );
    }

   // Here you can do what you want

}

Create a Resource

1. Create a new class like this:

class MyNewResource extends Resource.Resource<TheResultTypeExpected, TheApiParamsType> {
// TheResultTypeExpected, TheApiParamsType the both are set to any by default

    constructor(api : MyNewAPI){
        super(api, "path/to/your/resource");
    }

   // Add or override some methods if you want

}