Чёткого ответа не помню... давно задаюсь вопросом, зачем описывать АПИ

Question

Чёткого ответа не помню... давно задаюсь вопросом, зачем описывать АПИ

техписом? Это типа как код комментировать, который разрабы не хотят комментировать?
Это нужно, когда приложение заточено под интеграцию и только под неё? Если приложение не только для передачи приёма данных, а ещё и анализирует данные, то интеграцию описывают разрабы?

0

25.09.2023

6 ответов

15 просмотров

Марина Автор вопроса

Luiza
Время техписа скорее всего дешевле, и язык лучше

А на вторую часть вопроса знаете ответ?

0

25.09.2023

Виктор Орлов

Например, если у приложения микросервисная архитектура, а часто это так, то техпис может описывать методы каждого микросервиса. Получается документация внутренних API, которая помогает разработчикам и аналитикам развивать продукт. Плюс улучшает онбординг коллег. Нужен отдельный человек для таких задач, так как документация большая и её нужно постоянно актуализировать. Техпис как раз подходит)

0

25.09.2023

Дарья Курнаева (Чернавина)

Виктор Орлов
Например, если у приложения микросервисная архитек...

Я вот сейчас по задаче думаю, нужно ли мне что-то ещё писать, если у команды есть информативный Swagger.

0

25.09.2023

Виктор Орлов

Дарья Курнаева (Чернавина)
Я вот сейчас по задаче думаю, нужно ли мне что-то ...

Вообще, я тоже слабо представляю, зачем просто сваггер или код документировать) Мне на работе нужно фиксировать в документации, как поведение системы зависит от параметров АПИ зависит. Если оно сложное, то комментариев в коде и Сваггера просто недостаточно, чтобы полностью параметры описать. Типа есть параметр в АПИ — нужно описать, какие у него могут быть значения / кто источник / для чего нужен и т. д.)

0

25.09.2023

Natalya Antonova

когда что-то частями задокументировано, есть в БП, описаниях задач, сваггере, тогда техписатель, то бишь я когда ничего нет и надо копать код, восстанавливать данные и прочее, тогда сначала аналитики, потом я но у нас не чистое API, у нас описание микросервисов с кучей интеграций

0

25.09.2023

Luiza · Accepted Answer

Luiza

Время техписа скорее всего дешевле, и язык лучше

0

25.09.2023

Похожие чаты

Чёткого ответа не помню... давно задаюсь вопросом, зачем описывать АПИ

6 ответов

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