Nearly Perfect Mediocracy

    @tinkoff/swagger-types-generator
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.10 • Public • Published

    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 -

    Keywords

    none

    Install

    npm i @tinkoff/swagger-types-generator

    DownloadsWeekly Downloads

    40

    Version

    0.0.10

    License

    Apache-2.0

    Unpacked Size

    80.8 kB

    Total Files

    44

    Last publish

    Collaborators

    • makar_l
    • tinkoffbank
    • tom910
    • dmitry-korolev
    • rouland
    • ishivan
    • ytsareva
    • shoom3301
    • waterplea
    • meskill
    • marsibarsi
    • zig-green
    • defenderbass
    • super_oleg
    • dersizes
    • alexkvak