У меня есть проект, в котором я создал сервер с JSON API. API JSON реализован с использованием библиотеки GSON *1001*, что означает, что у меня есть Java классы для всех объектов JSON, которые понимает сервер. Каждый запрос, который получает сервер, анализируется с использованием GSON и сопоставляется с одним из этих Java классов. Все эти классы имеют комментарий JavaDo c, который объясняет все параметры этого класса и порядок его использования. Учитывая, что эти классы автоматически отображаются на запросы, которые понимает сервер, JavaDo c также будет довольно хорошей документацией для этого JSON api.
Однако, я ожидаю, что могут быть другие разработчики, разрабатывающие против этого JSON API на других языках, которые могут быть не знакомы с JavaDo c и как это переводит на JSON, понятный серверу. Поэтому я хотел бы автоматически сгенерировать JSON семплов для каждого класса и присоединить их к файлам JavaDo c html.
Создание семплов JSON было бы легко с помощью GSON:
MyRequest request = new MyRequest();
String json = new Gson().toJson(request);
Единственное, что я не смог найти, это то, есть ли в JavaDo c какой-либо API для присоединения результирующего json к html.
. Если это поможет, я использую Maven. в качестве инструмента для сборки.