Генерисани типово безбедни клијентски SDK-ови објављени

! Овај чланак садржи технички жаргон

Шта је ново

У нашем пост о миграцији на TypeScript, споменули смо да ће генерисани клијентски 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-јем аутоматски. Ваш компилатор уочава грешке у називима поља и недостајуће параметре пре него што ваш код икада пошаље мрежни захтев.

Како функционише

Миграција на TypeScript била је предуслов за ово. Сада када је наш серверски код потпуно типизован, користимо нашу форку TSOA да генеришемо OpenAPI 3.0 спецификацију директно из наших контролера рута. Та спецификација се уноси у OpenAPI Generator да би произвела клијентске библиотеке за сваки језик.

Када се API промени, наш алат открива разлику у спецификацији, регенерише погођене SDK-ове, покреће тестове за сваки језик и аутоматски отвара захтеве за спајање (pull requests). Направили смо мали управљачки алат у Nim-у који оркеструје циклус ажурирања‑тестирања‑издавања кроз свих десет репозиторијума.

Шта се налази у сваком SDK-у

Сваки SDK пружа две API класе:

• DefaultApi: аутентификовани крајњи тачке који захтевају ваш API кључ. Користите их на серверу за модерацију, управљање корисницима, аналитику и масовне операције.
• PublicApi: неаутентификовани крајњи тачке безбедне за позив из прегледача и мобилних апликација. Оне обухватају преузимање коментара, постављање, гласање и друге операције усмерене ка клијенту.

Сви SDK-ови такође укључују SSO алате за интеграцију са вашим постојећим системом аутентификације. TypeScript SDK додатно пружа претплате на догађаје у реалном времену за живо коментарисање.

Документација

Пуна API документација је доступна на docs.fastcomments.com. Сваки репозиторијум SDK-а такође укључује генерисану документацију која покрива сваку доступну методу и модел.

За SSO интеграцију, погледајте наш SSO водич. Сви десет SDK-ова укључују SSO помоћнике користећи њихове изворне криптографске библиотеке.

У закључку

Имање потпуно типизованог сервера учинило је лакшим генерисање поуздане OpenAPI спецификације, а одатле, генерисање клијената за десет (и једног дана више!) језика било је углавном питање изградње аутоматизације и унапређења наших типова дефиниција тако да буду употребљиве, без додавања превише апстракције која би успорила FastComments!

Као и свака велика издања, задовољни смо што смо успели да одвојимо време за оптимизацију, тестирање и правилно издавање ових SDK-ова. Јавите нам у наставку ако имате било какве повратне информације или ако постоји језик који бисте желели да додамо.

Поздрав!