Теперь Кью работает в режиме чтения

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

Какой самый лучший способ документирования rest api?

ПрограммированиеИнтернет+2
Анонимный вопрос
  ·   · 601
0KLRg9GCINC90LXRgiDQvdC40YfQtdCz0L4g0LjQvdGC0LXRgN...  · 25 дек 2020

На данный момент широко используется https://swagger.io/specification/

По запросам вида "rest api schema" выдаются ссылки именно на него.

Для большинства python web framework-ов есть готовые расширения, позволяющие автоматически построить схему.

Справедливости ради надо заметить, что swagger - не совсем документация, это техническая схема. Но если её правильно оформить и дополнить описанием, то из неё всегда можно сделать хорошую человекочитаемую документацию.

1 эксперт согласен