0.1.17 • Published 9 months ago

@alex_mercy/nest-swagger-codegen v0.1.17

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

NEST JS codegen (mvp 0)

Что умеет:

генерирует по swagger.yaml контроллеры и dto с учетом nestjs/swagger плагина.

Важно !

  • Не редактируйте файлы .dto.ts и .controller.ts, так как они генерируемые и отключить их генерацию нельзя! Исключением является поправить стили и добавить импорты, пока это не будет создано

  • Не используйте схемы без названия, так как nest при обратной генерации понимает только именованные схемы. Например:

# Правильно
put:
  parameters:
    - name: uuid
      required: true
      in: path
      schema:
        type: string
  requestBody:
    required: true
    content:
      application/json:
        schema:
          $ref: "#/components/schemas/CategoryBody" # правильно

# Неправильно
put:
  parameters:
    - name: uuid
      required: true
      in: path
      schema:
        type: string
  requestBody:
    required: true
    content:
      application/json:
        schema:
          type: object # неправильно, ошибка. Используйте $ref
          properties:
            title:
              type: string
          required:
            - title

Hints:

  • понимает $ref;
  • понимает enums;
  • сортирует роуты по методам;
  • поддерживает allOf;
  • можно изменить путь генерации;
  • можно использовать вместе с nest cli

TODOS:

  1. добавить линтеры;
  2. настроить shared импорты dto-шек;
  3. сделать опциональную интеграцию модулей в app module;
  4. сделать опциональную генерацию модулей;
  5. сделать опциональную генерацию сервисов (*.service.draft.ts);
  6. добавить интеграцию дополнительных параметров (example, min, minLength и тд) в dto
  7. добавить опциональную генерацию entity
  8. рефактор всего кода.
  9. сделать обработку ошибочных ответов (4хх,5хх статусы) (возможно в таску про сервисы)
0.1.17

9 months ago

0.1.16

9 months ago

0.1.15

9 months ago

0.1.14

9 months ago

0.1.13

10 months ago

0.1.12

10 months ago

0.1.11

10 months ago

0.1.10

10 months ago

0.1.8

10 months ago

0.1.7

10 months ago

0.1.6

10 months ago

0.1.5

10 months ago

0.1.4

10 months ago

0.1.3

10 months ago

0.1.2

10 months ago

0.1.1

10 months ago

0.1.0

10 months ago

1.0.0

10 months ago