Generated Type-Safe Client SDKs Released

! This Article Contains Technical Jargon

What's New

У нашому TypeScript migration post ми згадали, що згенеровані клієнтські SDK з'являться. Вони вже тут.

FastComments тепер постачає офіційні, типобезпечні SDK для десяти мов:

• TypeScript / JavaScript (npm)
• Python (GitHub)
• Rust (crates.io)
• Go (Go modules)
• Java (Maven)
• PHP (Composer)
• Ruby (RubyGems)
• Swift (Swift Package Manager)
• C++ (CMake)
• Nim (Nimble)

Кожен SDK генерується з того ж специфікації OpenAPI, яку створює наш сервер. Типи, сигнатури методів та моделі запитів/відповідей автоматично синхронізуються з реальним API. Ваш компілятор виявляє помилки в назвах полів та відсутні параметри ще до того, як ваш код здійснить мережевий запит.

How It Works

Міграція на TypeScript була передумовою для цього. Тепер, коли код нашого сервера повністю типізований, ми використовуємо our fork of TSOA для генерації специфікації OpenAPI 3.0 безпосередньо з наших контролерів маршрутів. Ця специфікація передається в OpenAPI Generator, який створює клієнтські бібліотеки для кожної мови.

Коли API змінюється, наші інструменти виявляють різницю у специфікації, регенерують відповідні SDK, запускають тести для кожної мови та автоматично відкривають pull request'и. Ми створили невеликий інструмент-менеджер на Nim, який координує цикл оновлення‑тестування‑випуску у всіх десяти репозиторіях.

What's in Each SDK

Кожен SDK надає два API‑класи:

• DefaultApi: аутентифіковані кінцеві точки, які вимагають ваш API‑ключ. Використовуйте їх на сервері для модерації, управління користувачами, аналітики та пакетних операцій.
• PublicApi: неаутентифіковані кінцеві точки, безпечні для виклику з браузерів та мобільних додатків. Вони охоплюють отримання коментарів, публікацію, голосування та інші операції, орієнтовані на клієнта.

Усі SDK також містять утиліти SSO для інтеграції з вашою існуючою системою аутентифікації. TypeScript SDK додатково надає підписки на події в реальному часі для живих коментарів.

Documentation

Повна документація API доступна за адресою docs.fastcomments.com. Кожен репозиторій SDK також містить згенеровану документацію, що охоплює всі доступні методи та моделі.

Для інтеграції SSO перегляньте наш SSO guide. Усі десять SDK включають SSO‑помічники, які використовують їхні власні криптографічні бібліотеки.

In Conclusion

Наявність повністю типізованого сервера спростила створення надійної специфікації OpenAPI, а далі — генерацію клієнтів для десяти (і колись більше!) мов, що в основному полягало у побудові автоматизації та удосконаленні наших типових визначень, щоб вони були придатними до використання, без надмірної абстракції, яка могла б уповільнити FastComments!

Як і з усіма великими випусками, ми раді, що змогли знайти час для оптимізації, тестування та правильного випуску цих SDK. Дайте нам знати нижче, якщо у вас є відгуки або якщо є мова, яку ви хотіли б, щоб ми додали.

З найкращими побажаннями!