@webitel/api-services

Contents:

$3

_Source: webitel swagger file._

$3

API clients – self-written api wrappers on top of gen services.

$3

Exports:

$3

``ts
// zod, services, msw
import {
createSourceBody, // zod
getSources, // api service
getListSourcesResponseMock, // mock
} from '@webitel/api-services/gen';
`

$3

`ts
import {
// enums, types and interfaces
} from '@webitel/api-services/gen/models';
`

$3

`ts
import {
// get list of top-level field keys. useful to sanitize fieldsToSend
getShallowFieldsToSendFromZodSchema,
// DONT USE. same, but for nested fields
getFieldsToSendFromZodSchema,
// pass zod schema, pass empty object, get object with default values
getDefaultsFromZodSchema,
} from '@webitel/api-services/gen/utils';
`

$3

See "contents" section.

`ts
import { ContactsAPI } from '@webitel/api-services/api';
`

$3

API transformers, used to transform data before sending it to the server or after receiving it from the server.

`ts
import { applyTransform } from '@webitel/api-services/api';
`

$3

API defaults: default axios instance, default getList response, etc

`ts
import { getDefaultInstance } from '@webitel/api-services/api/defaults';
`

Usage

$3

Useful for parallel development, testing, and debugging.
Calling a mock returns fake generated data, without sending a request to the server.

`ts
import { getSources } from '@webitel/api-services/gen';

const searchSources = getSources().listSources();
`
->

`ts
import { getListSourcesResponseMock } from '@webitel/api-services/gen';
`

FAQ

$3

A: Run this
manual workflow.

$3


A: https://raw.githubusercontent.com/webitel/protos/main/swagger/api.json`

$3

A: Automated version patching on each action run.
minor/major version bump is manual, if needed.

Related links:

* backend proto annotations guideline/docs/proto_annotation_guidelines.md)