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

Добрый день, подделитесь пожалуйста опытом, в чем описывает/описывали доку для

апи? плюсы минусы

21 ответов

16 просмотров
Maksim-Melnichuk Автор вопроса
Пользователь 61556
swager

что-то глянул не понравился он мне, тоже вопрос как бороться с добавлением новых методов изменения существующих, какое-то разделение по версионности в доке

Maksim Melnichuk
что-то глянул не понравился он мне, тоже вопрос ка...

Сделал - сгенерировал, вышла новая версия АПИ - кодируй в другое место.

Maksim-Melnichuk Автор вопроса
Пользователь 61556
Сделал - сгенерировал, вышла новая версия АПИ - ко...

вы не поняли видимо. для фронтенщика например удобно смотреть что поменялось

Maksim-Melnichuk Автор вопроса
Пользователь 61556
swager для фронта чем не подходит?

точно не поняли)) changelog нужен в доке, чтобы отображались изменения, swagger уже давно динозавр и как по мне не удобное дерево документации, когда ты листаешь этот список

Пользователь 61556
swager для фронта чем не подходит?

1) Написал код, 2) сделал к нему сваггер комменты. 3) Запустил в консоли комануд пересборки сваггер документации 4) Зашел по ссылке и увидел все методы с параметрами, возможностью отправить запросы из html

Maksim-Melnichuk Автор вопроса
Maksim-Melnichuk Автор вопроса
Пользователь 61556
1) Написал код, 2) сделал к нему сваггер комменты...

точно не поняли) это вы описали ваш рабочий процесс каждый день) а что вчера было и изменилось по сравнению с сегодняшним днем вы как-то фронтенщику сообщите? или просто поменяете доку на метод

Maksim Melnichuk
точно не поняли)) changelog нужен в доке, чтобы от...

ну и чендж лог - такая себе затея. ендпоинт менятся не должен! если он меняется то надо создавать отдельный ендпоинт. желатенльно с версией в path, по семвер

Maksim-Melnichuk Автор вопроса
Oleksandr Kapustin
ну и чендж лог - такая себе затея. ендпоинт менятс...

ну в момент разработки он всегда меняется, это не значит что надо создавать 300 эндпоинтов ))

Maksim Melnichuk
точно не поняли) это вы описали ваш рабочий процес...

Мне кажется, что если у вас меняется дока на метод - это уже проблема архитектуры приложения

Maksim Melnichuk
ну в момент разработки он всегда меняется, это не ...

ченджлог для разработки как бы тоже не надо))

Maksim-Melnichuk Автор вопроса
Oleksandr Kapustin
ченджлог для разработки как бы тоже не надо))

с чего так решили? ) есть кстати хороший сервис который дает крутой инструмент, но он дорогой, там как раз уделили внимание этому моменту

Maksim Melnichuk
ну в момент разработки он всегда меняется, это не ...

Есть бизнесзадача эндопоинта. Есть входные параметры и есть что должно быть на выходе - и это по сути должно быть констаной всегда и не меняться. Если появляются или удаляются эти правла, жди где-то краша. Особенно если твое АПИ юзает даже 1000 человек, явно они все у себя менять методы не ожидают

Alexey Gevondyan
у них пока не настолько все серьезно вроде

Если на стадии разработки, то чем конечный список АПИ не подходит?

Maksim-Melnichuk Автор вопроса
Пользователь 61556
Есть бизнесзадача эндопоинта. Есть входные парамет...

я вас уже услышал выше ) но за мнение спасибо я бы не стал следовать вашим подходом, спорить тоже не буду)

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

Обсуждают сегодня

а через ESC-код ?
Alexey Kulakov
29
30500 за редактор? )
Владимир
47
Чёт не понял, я ж правильной функцией воспользовался чтобы вывести отладочную информацию? но что-то она не ловится
notme
18
У меня есть функция где происходит это: write_bit(buffer, 1); write_bit(buffer, 0); write_bit(buffer, 1); write_bit(buffer, 1); write_bit(buffer, 1); w...
~
13
Недавно Google Project Zero нашёл багу в SQLite с помощью LLM, о чём достаточно было шумно в определённых интернетах, которые сопровождались рассказами, что скоро всех "ибешни...
Alex Sherbakov
5
Как передать управляющий символ в открытую через CreateProcess консоль? Собсна, есть процедура: procedure TRedirectThread.WriteData(Data: OEMString); var Written: Cardinal;...
Serjone
6
в JclConsole объявлено так: function CtrlHandler(CtrlType: DWORD): BOOL; stdcall; - где ваше объявление с stdcall? у вас на картинке нет stdcall
Karagy
8
Ребят в СИ можно реализовать ООП?
Николай
33
program test; {$mode delphi} procedure proc(v: int32); overload; begin end; procedure proc(v: int64); overload; begin end; var x: uint64; begin proc(x); end. Уж не знаю...
notme
6
https://github.com/erlang/otp/blob/OTP-27.1/lib/kernel/src/logger_h_common.erl#L174 https://github.com/erlang/otp/blob/OTP-27.1/lib/kernel/src/logger_olp.erl#L76 15 лет назад...
Maksim Lapshin
20
Карта сайта