Несколько месяцев назад я опубликовал шаблон проекта API, написанный на машинописном языке, о шаблоне для создания проекта API на машинописном языке.

Теперь я внес некоторые изменения, особенно в согласованность стилей кода, покрытие модульными тестами, документацию swagger и типы.


Какие новости?

  • Улучшите модульный тест покрытия для репозиториев и сервисов с помощью Jest.

Покрытие юнит-тестами

  • Структура проекта рефакторинга, как показано ниже
├── .husky/                     # Pre-commit config for lint staged
├── docs/                       # Swagger API docs
├── src/                        # All application source
├──── @types/                   # Type definition for modules
|
├──── api/
├────── controllers/            # Define all controllers
├────── middlewares/            # Define all middlewares
├────── models/                 # Define all sequelize models
├────── repositories/           # Define all repositories
├────── routes/
├──────── v1/                   # Define all v1 routes
├────── services/               # Define all services
├────── types/                  # Define all input types
|
├──── config/
├────── appConfig.ts            # Define app configuration
|
├──── constants/                # Define all constants
├──── database/                 # Define database connection and sync tables
├──── utils/                    # Define reusable libs
├──── server.ts                 # Create express config
├──── index.ts                  # ENTRYPOINT - Start server
|
└── ...
Войти в полноэкранный режим

Выйти из полноэкранного режима

  • Улучшите стиль кода, используя классы в репозиториях, службах и контроллерах.
  • Добавьте экспресс-валидатор в качестве промежуточного программного обеспечения для проверки запроса API.
  • и более того…

Подробнее о шаблоне проекта API версии 2.0.0 см. в этом репо
arifintahu/project-structure-api — GitHub