使用 Spring Restdoc 时配置 asciidoctor

问题描述

我正在采用 Spring Rest Docs，并且测试成功创建了 *.adoc 文件。

我在 src/docs/asciidoc 目录下创建了 api-guide.doc 文件来创建 html，但是当我将 asciidoc 作为 gradle 任务运行时，它会产生以下错误。

Some problems were found with the configuration of task ':asciidoctor' (type 'asciidoctorTask').
  - In plugin 'org.asciidoctor.convert' type 'org.asciidoctor.gradle.asciidoctorTask' method 'asGemPath()' should not be annotated with: @Optional,@InputDirectory.

我用spring初始化器初始化了项目，所以相信gradle依赖没有问题。

plugins {
    id 'org.springframework.boot' version '2.5.3'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id 'org.asciidoctor.convert' version '1.5.8'
    id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

ext {
    set('snippetsDir',file("build/generated-snippets"))
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-actuator'
    implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
    implementation 'org.springframework.boot:spring-boot-starter-validation'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    developmentOnly 'org.springframework.boot:spring-boot-devtools'
    runtimeOnly 'com.h2database:h2'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'

}

test {
    outputs.dir snippetsDir
    useJUnitPlatform()
}

asciidoctor {
    inputs.dir snippetsDir
    dependsOn test
}

可能是什么问题？

解决方法

一个 update needs to be made to https://start.spring.io 以便生成与 Gradle 7 兼容的配置。

您可以通过降级到 Gradle 6.x 来避免该问题，或者您可以通过将 id 'org.asciidoctor.convert' version '1.5.8' 替换为 id 'org.asciidoctor.jvm.convert' version '3.3.2' 来切换到更新版本的 Asciidoctor Gradle 插件

asciidoctor spring-boot spring-restdocs