0.0.10 • Published 4 years ago

@tinkoff/swagger-types-generator v0.0.10

Weekly downloads
126
License
Apache-2.0
Repository
-
Last release
4 years ago

swagger-types-generator

Генератор typescript типов по swagger-схемам

Установка

# yarn
yarn add --dev @tinkoff/swagger-types-generator

# npm
npm install --save-dev @tinkoff/swagger-types-generator

Пример

swagger-types-generator ./config.json

config.json:

{
    "schemas": [
        {
            "url": "https://tinkoffcreditsystems.github.io/invest-openapi/swagger-ui/swagger.yaml",
            "format": "yaml"
        }
    ],
    "projectDir": "./path/to/your/project"
}

Config

СвойствоОписаниеОбязательность
schemasМассив SwaggerSchema[]+
projectDirДиректория проекта+
isCachingEnableФлаг "Сохранять ли скаченные swagger-схема в директории проекта?", используется для отладки-
isActionsEnableФлаг "Попытаться сгенерировать ts-описание для action'ов"-

SwaggerSchema

СвойствоОписаниеОбязательность
urlАдрес swagger-схемы+
namespaceПространство имён для типов-
fileNameИмя файла, сохраняемого при кешировании-
formatФормат схемы, yaml или json, по-умолчанию json-