В документации достаточно много бардака и не используется никакой четкий стандарт, так как судя по всему она чисто рукописная, что не имеет особого смысла при наличии готовых решений которые делают хорошую документацию, клиент на основе схемы и прочее - автоматически.
Я накидал черновой вариант, он уже рабочий и покрывает основную часть документации, однако в связи с качеством текущей, сложно описать все полностью без «метода тыка».
Из того что еще не сделано в полной мере, это:
Некоторые поля ответа вроде rutube
Немного полей в которых стоило бы добавить example: не имеют таковой
Не добавлена авторизация и ее эндпоинт
Отсутствует WS
По мере возможности она будет дополниться / обновляться до более актуального состояния (хотя бы для начала по первым двум пунктам). Я бы был рад любой помощь с этим. Для большего удобства можно было бы добавить желающих как участников в организацию на SwaggerHub.
В документации достаточно много бардака и не используется никакой четкий стандарт, так как судя по всему она чисто рукописная, что не имеет особого смысла при наличии готовых решений которые делают хорошую документацию, клиент на основе схемы и прочее - автоматически.
Я накидал черновой вариант, он уже рабочий и покрывает основную часть документации, однако в связи с качеством текущей, сложно описать все полностью без «метода тыка».
Из того что еще не сделано в полной мере, это:
rutubeexample:не имеют таковойПо мере возможности она будет дополниться / обновляться до более актуального состояния (хотя бы для начала по первым двум пунктам). Я бы был рад любой помощь с этим. Для большего удобства можно было бы добавить желающих как участников в организацию на SwaggerHub.