opium
@opium
Просто люблю качественно работать

Как вы документируете свои rest api?

К примеру написал я свой rest api, хочу дать его всем пользоваться, если ли какие то стандартные способы создания документации или гайды, кукбуки по созданию документации.
  • Вопрос задан
  • 7117 просмотров
Пригласить эксперта
Ответы на вопрос 5
VaiMR
@VaiMR
К примеру en.wikipedia.org/wiki/Web_Application_Description_Language. А для себя (два разработчика, клиент и сервер) google docs выручает, чтобы не заморачиваться.
Ответ написан
Wott
@Wott
Я считаю что REST APi должен очень простым и понятным, но действительно сложными представлениями я пока не рулил.

В качестве доки я обычно даю минимальный пример взаимодействия в котором комментирую необходимые действия и привожу должные ответы от сервиса. В принципе наверно можно найти тулзу которая приведет код примера к красивому html, но это скорее вопрос генерирования док вообще а не для api.
Ответ написан
Fesor
@Fesor
Full-stack developer (Symfony, Angular)
У меня все REST методы описываются через аннотации (Symfony 2) ну и потом по ним генерится документация. Добавить туда примеры с curl проблемы не составляет.
Ответ написан
Ваш ответ на вопрос

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

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