zualex
@zualex
Senior Software Engineer

Что лучше apiDoc или swagger?

Есть проект на php, и апи этого проекта недокументированно никак.
Поискал и сходу нашёл два решения:
- Swagger
- apiDoc

Как понимаю суть у них одинаковая, на основе аннотаций строится документация.
Попытался определить плюсы и минусы.
- Swagger мне показался более гибким, можно прямо на лету сгенерировать доку, но аннотации слишком объемные и захламляют код.
- apiDoc менее гибкая, но более человеко-понятные аннотации.

Кто пользовался распишите плюсы и минусы, или может еще какое решение есть?
  • Вопрос задан
  • 1365 просмотров
Решения вопроса 2
dimonchik2013
@dimonchik2013
non progredi est regredi
у swagger пользователей больше апидока в 20+ раз, смотрите на апидок как на ваше кастомное решение, а на сваггер - как на пром стандарт
Ответ написан
Комментировать
@mamont80
Кстати swagger уже устарел. Смотри лучше open api 3. И ещё, есть куча утилит, с помощью которых можно относительно легко самому генерить доки. Я пошел этим путём по swagger, так как стандартные генераторы не понравились
Ответ написан
Комментировать
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы