PavelUstyugov
@PavelUstyugov
php

В чем лучше вести справочник своих api для себя и коллег?

Разрабатываю в день по 10-20 api развивающегося проекта. Всё это нужно куда-то записывать. Ищу инструмент для ведения этого. чтоб коллеги могли через поиск найти нужную функцию и посмотреть описание ее параметров входных и выходных и увидеть примеры.

Порекомендуйте?
  • Вопрос задан
  • 153 просмотра
Пригласить эксперта
Ответы на вопрос 5
xmoonlight
@xmoonlight
https://sitecoder.blogspot.com
Подборка инструментов для документирования API.
Ответ написан
makssof
@makssof
Web-разработчик
Swagger + ReDoc, и не знать бед
Ответ написан
Очевидный свагер. Вам с таким темпом проще всего генерировать доки из каментов, что свагер умеет. Если же вы, во всем вашем многообразии, сторонники перфекционизма, можете и вручную писать. Это не сложно, в чем-то даже проще автогенерации - не придется стукаться о подводные камни. Так, в моей тиме не смогли генерировать enum вне отдельных моделей. Для ручного заполнения рекомендовал бы Notion.
Ответ написан
efrolov54rus
@efrolov54rus
Младший Web-разработчик (принимаю заказы)
Михаил Жабко
. чтоб коллеги могли через поиск найти нужную функцию и посмотреть описание ее параметров входных и выходных и увидеть примеры.

Советую The Guide если под Windows
Ответ написан
Ваш ответ на вопрос

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

Войти через центр авторизации
Похожие вопросы
27 окт. 2020, в 15:28
100000 руб./за проект
27 окт. 2020, в 15:24
25000 руб./за проект