@vality/swag-api-keys-v2 v0.1.2

@vality/swag-api-keys-v2@0.1.2

Vality API Keys Management API является интерфейсом для управления набором API-ключей, используемых для авторизации запросов к основному API с ваших бэкенд-сервисов. Любые сторонние приложения, включая ваш личный кабинет, являются внешними приложениями-клиентами данного API. Мы предоставляем REST API поверх HTTP-протокола, схема которого описывается в соответствии со стандартом OpenAPI 3. Коды возврата описываются соответствующими HTTP-статусами. Платформа принимает и возвращает значения JSON в теле запросов и ответов. OAS3: https://swagger.io/specification/ ## Идентификатор запроса При любом обращении к API в заголовке X-Request-ID соответствующего запроса необходимо передать его уникальный идентификатор: X-Request-ID: 37d735d4-0f42-4f05-89fa-eaa478fb5aa9 ## Формат содержимого Любой запрос к API должен выполняться в кодировке UTF-8 и с указанием содержимого в формате JSON. Content-Type: application/json; charset=utf-8 ## Максимальное время обработки запроса При любом обращении к API в заголовке X-Request-Deadline соответствующего запроса можно передать параметр отсечки по времени, определяющий максимальное время ожидания завершения операции по запросу: X-Request-Deadline: 10s По истечении указанного времени система прекращает обработку запроса. Рекомендуется указывать значение не более одной минуты, но не менее трёх секунд. X-Request-Deadline может: задаваться в формате date-time согласно RFC 3339; задаваться в относительных величинах: в миллисекундах (150000ms), секундах (540s) или минутах (3.5m).

The version of the OpenAPI document: 0.1.0

Building

To install the required dependencies and to build the typescript sources run:

npm install
npm run build

Publishing

First build the package then run npm publish dist (don't forget to specify the dist folder!)

Consuming

Navigate to the folder of your consuming project and run one of next commands.

published:

npm install @vality/swag-api-keys-v2@0.1.2 --save

without publishing (not recommended):

npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save

It's important to take the tgz file, otherwise you'll get trouble with links on windows

using npm link:

In PATH_TO_GENERATED_PACKAGE/dist:

npm link

In your project:

npm link @vality/swag-api-keys-v2

Note for Windows users: The Angular CLI has troubles to use linked npm packages. Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround. Published packages are not effected by this issue.

General usage

In your Angular project:

// without configuring providers
import { ApiModule } from '@vality/swag-api-keys-v2';
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 {}

// configuring providers
import { ApiModule, Configuration, ConfigurationParameters } from '@vality/swag-api-keys-v2';

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 {}

// configuring providers with an authentication service that manages your access tokens
import { ApiModule, Configuration } from '@vality/swag-api-keys-v2';

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

import { DefaultApi } from '@vality/swag-api-keys-v2';

export class AppComponent {
    constructor(private apiGateway: DefaultApi) { }
}

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

Using multiple OpenAPI files / APIs / ApiModules

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 'my-api-path';
import { ApiModule as OtherApiModule } from 'my-other-api-path';
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 {

}

Set service base path

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

import { BASE_PATH } from '@vality/swag-api-keys-v2';

bootstrap(AppComponent, [
    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
]);

or

import { BASE_PATH } from '@vality/swag-api-keys-v2';

@NgModule({
    imports: [],
    declarations: [ AppComponent ],
    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
    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,
  API_BASE_PATH: 'http://127.0.0.1:8080'
};

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

import { BASE_PATH } from '@vality/swag-api-keys-v2';
import { environment } from '../environments/environment';

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

Customizing 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:

new Configuration({
    encodeParam: (param: Param) => myFancyParamEncoder(param),
})