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

Question

phpGeeks

Maksim Melnichuk

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

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

#backend #php #programming #russian

0

10.02.2021

21 ответов

19 просмотров

Maksim Melnichuk Автор вопроса

Пользователь 61556
swager

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

0

10.02.2021

Пользователь 61556

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

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

0

10.02.2021

Maksim Melnichuk Автор вопроса

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

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

0

10.02.2021

Пользователь 61556

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

swager для фронта чем не подходит?

0

10.02.2021

Maksim Melnichuk Автор вопроса

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

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

0

10.02.2021

Oleksandr Kapustin

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

ок, openAPI ? :)

0

10.02.2021

Пользователь 61556

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

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

0

10.02.2021

Maksim Melnichuk Автор вопроса

Oleksandr Kapustin
ок, openAPI ? :)

что именно?

0

10.02.2021

Maksim Melnichuk Автор вопроса

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

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

0

10.02.2021

Oleksandr Kapustin

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

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

0

10.02.2021

Maksim Melnichuk Автор вопроса

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

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

0

10.02.2021

Пользователь 61556

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

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

0

10.02.2021

Пользователь 61556

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

+100500

0

10.02.2021

Oleksandr Kapustin

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

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

0

10.02.2021

Maksim Melnichuk Автор вопроса

Пользователь 61556
Мне кажется, что если у вас меняется дока на метод...

ахаха понял, учту 😂

0

10.02.2021

Maksim Melnichuk Автор вопроса

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

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

0

10.02.2021

Пользователь 61556

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

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

0

10.02.2021

Alexey Gevondyan

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

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

0

10.02.2021

Пользователь 61556

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

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

0

10.02.2021