Я задумался как описать апи сервера. И как лучше перенести

Question

Я задумался как описать апи сервера. И как лучше перенести

инфу со свагера в JSDoc
Пока придумал делать так:
конвертировать вручную в JSDoc а потом добавлять JSDoc прямо в useQuery(vue-query). Или может на слой с апи можно как-то перенести
В итоге типы подсвечиваются и сразу видно что можно достать не заходя в сваггер. Минус конечно, что нужна ручная синхронизация.
С TS подобное у нас было:
https://www.npmjs.com/package/openapi-typescript

Или может вообще так не лучшая практика? пусть будет один источник истины, чем так?

#programming #russian #vue.js

0

17.11.2023

1 ответов

16 просмотров

Eugen Blizzart · Answer 1

В общем хотел узнать: нормально или можно лучше сделать. Может ТипоАрхитекторы выскажуться) или просто кто с этим работал. А по поводу комментов JSDoc я понял, что лучший вариант - генерация свагера из JSDoc, а не наоборот. Сейчас просто поправил по принципу DRY и вызываю в компонентах где нужна инфа о юзере: const { data: userInfo } = useQuery(getUserInfo);

169 похожих чатов

Я задумался как описать апи сервера. И как лучше перенести

1 ответов

Похожие вопросы