tinkoff / swagger-types-generator Goto Github PK

сабж

В readme написано, что в SwaggerSchema поле fileName является необязательным, но если запустить генератор по примеру из readme вывалится ошибка

Потому что path не ожидает undefined в аргументах https://github.com/TinkoffCreditSystems/swagger-types-generator/blob/master/generator.ts#L51

Если прописать какой-нибудь fileName, то работает нормально

Сейчас из-за https://github.com/TinkoffCreditSystems/swagger-types-generator/blob/master/utils/convertFieldsToCamelCase.ts получается, что генерируемые типы не совпадают со swagger-схемами, что противоречит первому предложению в readme.

Я понимаю, что возможно в Тинькофф есть договорённости по именованию полей вложенных структур, и это правильные договорённости, но на фронте помимо преобразований имён переменных могут быть и другие преобразования, как обогащение данных с бекенда какими-то дополнительными данными или изменение структуры объекта под нужны фронтенда. И получается, что поведение библиотеки накладывает ограничение что преобразовывать данные приходится 2 раза: сначала к camelCase, а уже затем только к нужному для фронтенда виду.

For now the generator converts enums

TradeStatus:
  type: string
  enum:
    - NormalTrading
    - NotAvailableForTrading

OperationType:
  type: string
  enum:
    - Buy
    - Sell

into empty objects

type TradeStatus = {};

type OperationType = {};

I've made a fix #1 for it to convert enums into correct types

type TradeStatus = 'NormalTrading' | 'NotAvailableForTrading';

type OperationType = 'Buy' | 'Sell';