dappros / ethora

A 'super app' engine for your project. React Native (iOS, Android) and React.js (Web, desktop). Social Sign In 🄵, Messaging 💬 (chat, voice, push notifications), Web3 Wallet 🪪 (profile QR, documents, coins, NFT), DLT 🔐 (provenance, crypto signing), Gamification 🤩, Social Commerce and more.

Home Page:https://ethora.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Typization of the API and API documentation upgrade

phwizard opened this issue · comments

Based on feedback from frontend engineers and the internal discussions we had, the Swagger API documentation is lacking typization. We need jointly to fix and improve this.

We have already done phase 1 of improvements in API docs, so this will be Phase 2, which will be followed by improvements in the client-side TypeScript code.

Feedback

ENG:
After reviewing the project, I see that RN and React lack API typing everywhere. I came to this conclusion after reviewing your SWAGGER, API responses are not described everywhere, but simply says successful response 200, this leads to the fact that TypeScript on the front-end does not work at full capacity and in some cases the type is replaced by Any. When the API is better described it will also need to be transferred to React and the RN part.

UKR:
Оглянувши проєкт, я бачу що RN і React не всюди вистачає типізування API. Я прийшов до такого висновку, оглянувши ваш SWAGGER, там не всюди описані відповіді від API, а пише просто successful response 200, це приводить до того, що на front-end частині TypeScript працює не на повну і в деяки випадках тип заміняється на Any. Коли API буде краще описано це потрібно буде також перенести на React і RN частину.