Mon Feb 16 2026
...
Випущені згенеровані клієнтські SDK з типобезпекою
! Ця стаття містить технічну термінологію
Що нового
У нашому дописі про міграцію на TypeScript ми згадали, що згенеровані клієнтські SDK будуть доступні. Вони вже тут.
FastComments тепер постачає офіційні, типобезпечні SDK для десяти мов:
- TypeScript / JavaScript (npm)
- Python (PyPI)
- Rust (crates.io)
- Go (Go modules)
- Java (Maven)
- PHP (Composer)
- Ruby (RubyGems)
- Swift (Swift Package Manager)
- C++ (CMake)
- Nim (Nimble)
Кожен SDK згенерований за тією ж специфікацією OpenAPI, яку виробляє наш сервер. Типи, сигнатури методів і моделі запитів/відповідей автоматично синхронізуються з фактичним API. Ваш компілятор вчасно виявляє помилки в назвах полів та відсутні параметри ще до того, як ваш код зробить мережевий запит.
Як це працює
Міграція на TypeScript була передумовою для цього. Тепер, коли наш серверний код повністю типізований, ми використовуємо наш форк TSOA для генерації специфікації OpenAPI 3.0 безпосередньо з наших контролерів маршруту. Ця специфікація передається в OpenAPI Generator для створення клієнтських бібліотек для кожної мови.
Коли API змінюється, наші інструменти виявляють зміни у специфікації, регенерують уражені SDK, запускають тести для кожної мови і автоматично відкривають запити на злиття. Ми створили невеликий менеджерський інструмент на Nim, який координує цикл оновлення-тестування-випуску для всіх десяти репозиторіїв.
Що міститься в кожному SDK
Кожен SDK надає два API класи:
DefaultApi: аутентифіковані кінцеві точки, які вимагають ваш ключ API. Використовуйте їх на серверній стороні для модерації, управління користувачами, аналітики та масових операцій.PublicApi: неаутентифіковані кінцеві точки, які можна безпечно викликати з браузерів і мобільних додатків. Вони охоплюють отримання коментарів, публікацію, голосування та інші клієнтські операції.
Усі SDK також включають утиліти SSO для інтеграції з вашою існуючою системою аутентифікації. SDK для TypeScript додатково надає підписки на події в реальному часі для коментування.
Документація
Повна документація API доступна на docs.fastcomments.com. Кожен репозиторій SDK також включає згенеровану документацію, що охоплює кожен доступний метод і модель.
Для інтеграції SSO дивіться наш посібник з SSO. Усі десять SDK включають помічники SSO з використанням їхніх рідних криптографічних бібліотек.
У підсумку
Наявність повністю типізованого сервера спростила генерацію надійної специфікації OpenAPI, а звідти створення клієнтів для десяти (і колись більше!) мов було переважно справою побудови автоматизації та вдосконалення наших визначень типів, щоб вони були споживані, не додаючи занадто багато абстракції, яка могла б уповільнити FastComments!
Як і при всіх значних випусках, ми раді, що змогли знайти час для оптимізації, тестування та належного випуску цих SDK. Повідомте нас нижче, якщо у вас є будь-які відгуки або якщо є мова, яку ви хотіли б, щоб ми додали.
На здоров'я!
