@skriptfabrik/ng-api-client

skriptfabrik API Client for Angular

Author

skriptfabrik <[email protected]>

For more information, please visit https://www.skriptfabrik.com/api.

Installation

Requirements

• Angular (>= 15.2.0)
• RxJS (>= 7.8.0)

NPM

Install NPM

npm install @skriptfabrik/[email protected] --save

Usage

Please follow the installation instructions and then add one of the following variants to your project:

With default configuration

import { ApiModule } from '@skriptfabrik/ng-api-client';
import { HttpClientModule } from '@angular/common/http';

@NgModule({
    imports: [
        ApiModule,
        // make sure to import the HttpClientModule in the AppModule only,
        // see https://github.com/angular/angular/issues/20575
        HttpClientModule,
    ],
    declarations: [ AppComponent ],
    providers: [ ],
    bootstrap: [ AppComponent ],
})
export class AppModule { }

With custom configuration

import { ApiModule, Configuration, ConfigurationParameters } from '@skriptfabrik/ng-api-client';

export function apiConfigFactory (): Configuration {
    const params: ConfigurationParameters = {
        // set configuration parameters here.
    };
    return new Configuration(params);
};

@NgModule({
    imports: [ ApiModule.forRoot(apiConfigFactory) ],
    declarations: [ AppComponent ],
    providers: [ ],
    bootstrap: [ AppComponent ],
})
export class AppModule { }

With custom path parameter encoding

Without further customization, only path-parameters of style simple and Dates for format date-time are encoded correctly.

Other styles (e.g. matrix) are not that easy to encode and thus are best delegated to other libraries (e.g.: @honoluluhenk/http-param-expander).

To implement your own parameter encoding (or call another library), pass an arrow-function or method-reference to the encodeParam property of the Configuration-object (see General Usage above).

Example value for use in your Configuration-provider:

import { ApiModule, Configuration, ConfigurationParameters, Param } from '@skriptfabrik/ng-api-client';
import { FormParamExpander, LabelParamExpander, MatrixParamExpander, SimpleParamExpander } from '@honoluluhenk/http-param-expander';

const formExpander = new FormParamExpander();
const labelExpander = new LabelParamExpander();
const matrixExpander = new MatrixParamExpander();
const simpleExpander = new SimpleParamExpander();

export function apiConfigFactory (): Configuration {
    const params: ConfigurationParameters = {
        encodeParam: (param: Param) => {
            const value = param.dataFormat === 'date-time'
                ? (param.value as Date).toISOString()
                : param.value;

            switch (param.style) {
                case 'matrix':
                    return matrixExpander.expand(value);
                case 'label':
                    return labelExpander.expand(value);
                case 'form':
                    return formExpander.expand(value);
                case 'simple':
                    return simpleExpander.expand(value);
            }

            return encodeURIComponent(String(value));
        },
    };
    return new Configuration(params);
};

@NgModule({
    imports: [ ApiModule.forRoot(apiConfigFactory) ],
    declarations: [ AppComponent ],
    providers: [ ],
    bootstrap: [ AppComponent ],
})
export class AppModule { }

With authentication service that manages your access tokens

import { ApiModule, Configuration } from '@skriptfabrik/ng-api-client';

@NgModule({
    imports: [ ApiModule ],
    declarations: [ AppComponent ],
    providers: [
        {
            provide: Configuration,
            useFactory: (authService: AuthService) => new Configuration(
                {
                    basePath: environment.apiUrl,
                    accessToken: authService.createAccessToken.bind(authService),
                }
            ),
            deps: [ AuthService ],
            multi: false,
        },
    ],
    bootstrap: [ AppComponent ],
})
export class AppModule { }

With custom service base path

If different from the generated base path, during app bootstrap, you can provide the base path to your service.

import { BASE_PATH } from '@skriptfabrik/ng-api-client';

@NgModule({
    imports: [ ],
    declarations: [ AppComponent ],
    providers: [
        {
            provide: BASE_PATH,
            useValue: 'http://localhost:8080',
        },
    ],
    bootstrap: [ AppComponent ],
})
export class AppModule { }

Using @angular/cli

First extend your src/environments/*.ts files by adding the corresponding base path:

export const environment = {
    production: false,
    apiBasePath: 'http://localhost:8080',
};

In the src/app/app.module.ts:

import { BASE_PATH } from '@skriptfabrik/ng-api-client';
import { environment } from '../environments/environment';

@NgModule({
    declarations: [ AppComponent ],
    imports: [ ],
    providers: [
        {
            provide: BASE_PATH,
            useValue: environment.apiBasePath,
        },
    ],
    bootstrap: [ AppComponent ],
})
export class AppModule { }

With multiple ApiModules

The ApiModule is restricted to being instantiated once app wide. This is to ensure that all services are treated as singletons.

In order to use multiple ApiModules generated from different OpenAPI files, you can create an alias name when importing the modules in order to avoid naming conflicts:

import { ApiModule } from '@skriptfabrik/ng-api-client';
import { ApiModule as OtherApiModule } from 'other-api-package';
import { HttpClientModule } from '@angular/common/http';

@NgModule({
    imports: [
        ApiModule,
        OtherApiModule,
        // make sure to import the HttpClientModule in the AppModule only,
        // see https://github.com/angular/angular/issues/20575
        HttpClientModule,
    ]
})
export class AppModule { }

Credits

This Angular package is automatically generated by the OpenAPI Generator project:

• API version: 2.1.0+e417cb8
• Package version: 2.1.0
• Build date: 2023-03-03T13:15:46.789650Z[Etc/UTC]