Spring Boot
Если это проект Spring Boot, то не нужны две конфигурации Spring MVC, описанные выше. В проекте Spring Boot также нет файла web.xml для конфигурации.
Достаточно заменить зависимость httpdoc-spring-mvc на следующую и добавить аннотацию @EnableHttpdoc к классу точки входа проекта:
@SpringBootApplication
@EnableHttpdoc(
packages = {"io.httpdoc.sample"},
httpdoc = "服务名称",
version = "服务版本",
description = "服务描述 — поддерживает HTML-синтаксис."
)
public class HttpdocApplication {
public static void main(String[] args) {
SpringApplication.run(HttpdocApplication.class, args);
}
}
| Параметр |
Описание |
Значение по умолчанию |
| packages |
Имя пакета исходного кода |
Обязательный параметр, можно настроить несколько через запятую, пробел или перенос строки, поддерживается рекурсивный поиск |
| httpdoc |
Название проекта |
HttpDoc |
| version |
Версия проекта |
1.0.0 |
| description |
Описание проекта |
Можно использовать <![CDATA[]]> и HTML-теги |
| protocol |
Протокол доступа |
http или https, по умолчанию request.getProtocol(); |
| hostname |
Имя хоста |
request.getServerName(); |
| port |
Номер порта |
request.getServerPort(); |
| context |
Путь контейнера |
request.getContextPath(); |
| dateFormat |
Формат даты |
yyyy-MM-dd HH:mm:ss |
| translator |
Переводчик документов |
Автоматически соответствует текущей веб-структуре проекта |
| interpreter |
Интерпретатор документов |
Исходный интерпретатор |
| serializer |
Сериализатор документов |
JSON-сериализатор, поэтому проекту требуется зависимость от jackson-databind |
В модуле httpdoc-sample в этом проекте используется стандартный пример HttpDoc + SpringMVC. Его можно проверить после извлечения, чтобы увидеть исходный код и скомпилировать и запустить для просмотра эффекта. Также можно сразу просмотреть его:
Изменения
- v1.8.1
- Адаптировано к ситуациям, когда приложение находится за обратным прокси-сервером, а доменное имя переднего конца не получается правильно.
- v1.8.0
- Исправлена проблема с BaseURL и относительным путём интерфейса.
- v1.7.9
- Исправлена проблема с BaseURL и относительным путём интерфейса.
- v1.7.8
- В пользовательском интерфейсе параметры API по умолчанию отображаются в виде сетки.
- v1.7.7
- Обновлена зависимость LoadKit, что решает проблему с неправильным соответствием ANT-выражения */ подстановочному знаку.
- v1.7.6
- При генерации ObjC используется BOOL вместо bool.
- v1.7.5
- Параметры пустого объекта/пустого значения в тестовом интерфейсе не участвуют в сериализации JSON.
- v1.7.4
- Исправление ошибок генерации iOS SDK.
- v1.7.3
- Изменены методы получения полей типа boolean с get на is.
- v1.7.2
- Добавлена поддержка RxJava для клиента Retrofit2.
- v1.7.1
- Реорганизация зависимостей pom.
- Решение проблемы с искажением китайского языка при экспорте SDK.
- Обновление зависимости Jestful.
- v1.7.0
- Исправлено отсутствие аннотаций параметров при генерации методов API для Retrofit и Retrofit 2.
- v1.6.9
- Поддержка Retrofit 1 добавлена.
- Переименован модуль Retrofit 2.
- v1.6.8
- Возможность настройки формы экспорта SDK через параметры.
- Открыты дополнительные возможности расширения сторонних разработчиков.
- v1.6.7
- Исправлен баг с повторным построением документации при отсутствии исходного кода.
- Оптимизирована структура для более лёгкого расширения нескольких реализаций Translator.
- v1.6.6
- Проблема с генерацией Model, содержащей ключевые слова Java, исправлена.
- Контроллер поддерживает псевдонимы.
- v1.6.5
- Сортировка в соответствии с определением свойств bean.
- Использование LoadKit вместо Detector.
- v1.6.4
- Улучшена структура сжатых пакетов при экспорте.
- v1.6.3
- Параметр packages используется для фильтрации исходных пакетов кода, поддерживаются несколько исходных пакетов и рекурсивный поиск.
- Оптимизация логики извлечения исходного кода для адаптации к большему количеству режимов запуска.
- v1.6.2
- Обновлено использование фреймворка detector.
- v1.6.1
- Пользовательский интерфейс оптимизирован.
- v1.6.0
- Интеграция нескольких модулей с использованием фреймворка detector.
- v1.5.9
- Ссылки на объекты документов осуществляются через SoftReference, чтобы избежать чрезмерного использования памяти JVM в режиме ожидания.
- Экспортный интерфейс Exporter добавлен для экспорта SDK.
- Интерфейс для скачивания SDK доступен на странице.
- v1.5.8
- Глобальные настройки Schema добавлены.
- Адаптация к проблемам с рекурсивной Schema.
- v1.5.7
- Реализация JSONEditor на переднем конце добавлена.
- Тег @style используется для управления стилем отображения параметров.
- v1.5.6
- Ошибка с путями, содержащими китайские символы или пробелы, исправлена.
- Разделитель пути адаптирован для системы Unix.
- Отображение журнала чтения комментариев.
- v1.5.5
- Жизненный цикл интерфейса Lifecycle добавлен, позволяя классам реализации отслеживать события initial и destroy, а также пользовательские настройки.
- v1.5.4
- Скорость анализа комментариев исходного кода значительно увеличена.
- Зависимость spring-boot обновлена, добавлена зависимость spring-mvc.
- v1.5.3
- Упрощение зависимостей проекта для облегчения интеграции.
- По умолчанию используется JSON-документационный сериализатор.
- v1.5.2
- Первый официальный выпуск.
- v1.5.1
- Модуль примера добавлен.
- README.md добавлен.
Лицензионное соглашение
Apache-2.0.
Связаться с автором
QQ 646742615.
Комментарии ( 0 )