Как документировать API веб-сервиса?
У меня проблема с документированием API моего веб-сервиса. Написано на яве, потом пользуюсь java2wsdl создать файл wsdl и т. д.
Как мне создать документацию для этого? Мне нужна документация, которую я мог бы предоставить пользователю. Должен ли я документировать свой исходный код Java?
Как это должно быть сделано?
1 ответ
Решение
В вашем файле WSDL есть все детали, касающиеся сервиса. В нем четко указаны входные и выходные данные для вашего сервиса. Наряду с этим вы также можете предоставить подробную информацию о вашем сервисе в виде вики / документа, который объясняет сервис, ожидаемый ввод, ответ и коды ошибок и т. Д.
Если вам нужно, вы также можете сгенерировать JavaDoc для вашего проекта.