Аннотация. В этом проекте мы узнаем, как разработать комплект для разработки программного обеспечения с использованием Typescript и NodeJS.
Введение
В этом проекте мы узнаем, как разработать комплект для разработки программного обеспечения с использованием Typescript и NodeJS. Этот комплект позволит пользователям взаимодействовать с API-интерфейсом прикладного программирования.
Репозиторий GitHub
Избранные концепции
В приведенном ниже списке мы предоставим концепции и определения различных тем и технологий, которые мы использовали в этом проекте.
- Software Development Kit SDK — SDK расшифровывается как Software Development Kit. Это набор инструментов, библиотек и документации, которые позволяют разработчикам создавать приложения для конкретной платформы или системы. SDK предоставляют платформу, упрощающую процесс разработки за счет абстрагирования сложных функций и предоставления готовых компонентов или API (интерфейсов прикладного программирования), которые могут использовать разработчики.
- Диспетчер пакетов узла NPM — NPM означает диспетчер пакетов узла. Это менеджер пакетов для Node.js, популярной среды выполнения JavaScript. NPM — это инструмент командной строки, который позволяет разработчикам находить, устанавливать и управлять пакетами или библиотеками кода, которые можно использовать в проектах Node.js.
- NodeJS — Node.js — это кроссплатформенная среда выполнения JavaScript с открытым исходным кодом, которая позволяет разработчикам выполнять код JavaScript вне веб-браузера. Он построен на движке JavaScript V8, который является тем же движком, который используется в Google Chrome, и позволяет разработчикам запускать код JavaScript на стороне сервера.
- TypeScript — TypeScript — это надмножество JavaScript со строгой типизацией, разработанное Microsoft. Он добавляет в JavaScript необязательную статическую типизацию, предоставляя разработчикам более структурированный и надежный способ написания кода.
- Библиотека TypeScript. Библиотека TypeScript представляет собой набор кода, написанного на TypeScript, который предоставляет разработчикам определенные функции, утилиты или API для использования в своих проектах TypeScript или JavaScript. Библиотеки TypeScript аналогичны обычным библиотекам JavaScript, но они написаны на TypeScript и могут включать определения типов, чтобы улучшить опыт разработчика при их использовании в проектах TypeScript.
- JSON Placeholder — JSONPlaceholder — это поддельный онлайн-API REST для тестирования и создания прототипов. Он предоставляет набор конечных точек HTTP, которые имитируют поведение реального внутреннего API, позволяя разработчикам взаимодействовать с ним, как если бы это был настоящий сервер.
- Micro-Bundle — Micro-Bundle — это инструмент, используемый для объединения библиотек в различных форматах. Это особенно полезно для создания SDK или библиотек, которые должны поддерживать различные модульные системы, такие как CommonJS, ESM (модули ECMAScript) и UMD (универсальное определение модуля). Micro-Bundle упрощает процесс объединения и передачи кода TypeScript или JavaScript, обеспечивая совместимость с различными платформами и средами.
- Команды NPM Link. NPM Link — это команда в диспетчере пакетов узла (NPM), которая создает символическую ссылку между глобально установленным пакетом и локальным проектом. Это особенно полезно во время разработки, когда вы хотите протестировать пакет или библиотеку, которую используете.
- Командная строка. Командная строка, также известная как интерфейс командной строки (CLI), представляет собой текстовый пользовательский интерфейс для взаимодействия с компьютерной системой или программным приложением. Он позволяет пользователям отдавать команды компьютеру, вводя определенные инструкции или команды в терминале или командной строке.
- Homebrew — Homebrew — популярный менеджер пакетов для операционных систем macOS. Это позволяет пользователям легко устанавливать, обновлять и управлять программными пакетами и библиотеками из командной строки. Homebrew упрощает процесс установки программного обеспечения на macOS, автоматизируя загрузку, компиляцию и установку пакетов.
- VSCode — VSCode означает Visual Studio Code. Это бесплатный и очень популярный редактор исходного кода, разработанный Microsoft. VSCode предназначен для разработчиков и поддерживает широкий спектр языков программирования и фреймворков. Он предоставляет мощную и настраиваемую среду для написания, редактирования и отладки кода.
Рекомендуемые шаги
Шаг 1. Знакомство с SDK
- SDK (Software Development Kit) позволяет создавать приложения для разных платформ и абстрагирует специфику API, предоставляя разработчикам общий шаблон для подражания.
Шаг 2: Настройка проекта
- Создайте новую папку для своего проекта SDK.
- Инициализируйте проект NPM в папке с помощью «npm init».
- Установите библиотеку «microbundle» с помощью «npm install microbundle — save-dev».
Шаг 3: Настройте проект
- Добавьте необходимые данные в package.json, такие как имя, основной файл, скрипты, лицензия и т. д.
- Создайте файл tsconfig.json с необходимыми настройками.
Шаг 4: Напишите базовый класс
- Создайте файл «base.ts» с классом «Base», который принимает объект конфигурации в своем конструкторе.
- Реализуйте метод «request» в классе «Base», используя библиотеку «isomorphic-unfetch».
Шаг 5. Внедрение методов SDK
- Создайте папку «posts» в папке «src».
- В папке «posts» создайте файл «index.ts» для реализации методов, связанных с API сообщений (например, getPostById, getPosts, createPost).
Шаг 6: Используйте миксины
- Создайте файл «utils.ts», чтобы определить функцию миксина.
- Примените миксин к классу «posts», чтобы наследовать функциональность класса «Base».
Шаг 7. Создайте SDK
- Добавьте скрипт «build» в package.json, чтобы скомпилировать код TypeScript с помощью microbundle.
- Запустите «npm run build», чтобы сгенерировать файлы дистрибутива в папке «dist».
Шаг 8. Протестируйте локально
- Создайте новую папку для тестирования SDK.
- Инициализируйте проект NPM в папке тестирования.
- Свяжите SDK, используя «ссылку npm», чтобы протестировать его локально.
Шаг 9. Опубликуйте SDK (необязательно)
- Если вы хотите опубликовать SDK в реестре NPM, используйте «публикацию npm» после настройки учетной записи NPM.
Вот и все! Теперь вы разработали SDK с помощью TypeScript и протестировали его локально. При желании вы можете опубликовать его в реестре NPM для использования другими.