Документирование остальных API с использованием spring-restdocs в InteliJ Idea — это хорошо, но мне не хватает визуализированных «включающих» фрагментов макроса операция.
== Get Comments sorted
To get sorted according single attribute and with no specific ordering (asc-ending is default), you can refer to this example:
operation::comments/getSortedDescending[snippets='http-request,path-parameters,http-response']
Я ожидаю, что каким-то образом я смогу включить артефакт spring-restdocs-asciidoc для использования при рендеринге вещей в InteliJ Idea с плагином asciidoctor.
Связанная проблема https://github.com/asciidoctor/asciidoctor-intellij-plugin/issues/310
Я просмотрел spring-restdocs-asciidoctor. operation::[]
— это расширение, который отображает содержимое. Он зависит от атрибута snippets
, который необходимо установить.
Подключаемый модуль IntelliJ для AsciiDoc поддерживает как рубиновые расширения, так и атрибуты для превью в качестве экспериментальных параметров.
Чтобы заставить его работать, я сделал следующее:
gradlew asciidoctor
для создания фрагментов.asciidoctorconfig
, чтобы указать путь к сгенерированным фрагментам.asciidoctor
и поместите расширение в этот каталогВам необходимо подтверждать предупреждающее сообщение каждый раз, когда вы перезапускаете IDE. Поскольку он будет запускать код Ruby локально, это проблема безопасности. Возможно, мы улучшим его в будущем, поэтому вам нужно будет подтвердить его только после изменения кода расширения.
Изменения в следующей ветке: https://github.com/ahus1/spring-restdocs/tree/poc_extension_intellij
Он также поддерживает расширения Java, и вам необходимо скопировать файлы JAR в .asciidoctor/lib
. В прошлые выходные я играл с этим, чтобы интегрировать предварительную обработку Jamal в плагин IntelliJ Asciidoc, и он отлично работает.
Вы можете связаться с поставщиком плагина: plugins.jetbrains.com/plugin/7391-asciidoc