Spring Restdocs markieren optionale Parameter mit Asciidoc

Question

Ich verwende Spring Restdocs, um Dokumentation auf meinem REST Webapi zu erstellen; Ich habe das Ding integriert und mein HTML wird erzeugt (maven + asciidoc plugin, restassured apis). Das einzige Problem, das ich habe, ist, dass ifeval entweder nicht funktioniert wie angekündigt oder ich habe es falsch gemacht.

Mein individueller Anfrage-fields.snippet sieht wie folgt aus:

|=== 
|Path|Type|Description|Optional 

{{#fields}} 
|{{#tableCellContent}} 
ifeval::["{optional}"=="true"] 
    `{{path}}` 
endif::[] 
ifeval::["{optional}"="false"] 
    *`{{path}}`* 
endif::[] 
    {{/tableCellContent}} 
    |{{#tableCellContent}}`{{type}}`{{/tableCellContent}} 
    |{{#tableCellContent}}{{description}}{{/tableCellContent}} 
    |{{#tableCellContent}}{{optional}}{{/tableCellContent}} 

{{/fields}} 
|=== 

Der ‚optional‘ Wert im tablecellcontent korrekt wiedergegeben wird (‚true‘ oder ‚falsch‘ je nach Fall), aber die ifeval wird nicht geparst (und zeigt sich somit im letzten html ohne Fehler).

Ich versuchte verschiedene Syntaxen für den Ausdruck, aber keiner scheint zu funktionieren; Irgendwelche Hinweise auf die eventuell richtige Syntax? Ich denke darüber nach, ein benutzerdefiniertes Attribut zu definieren und ifndef zu verwenden, um das gleiche Ergebnis zu erhalten, aber ich würde es vorziehen, wenn möglich die vorhandene optionale() Unterstützung zu verwenden.

Da bat ich die resultierende .adoc bin Zugabe

|=== 
|Path|Type|Description|Optional 

| 
ifeval::["{optional}"=="true"] 
    `name` 
endif::[] 
ifeval::["{optional}"=="false"] 
    *`name`* 
endif::[] 
|`String` 
|Name of the new Axis 
|false 

| 
ifeval::["{optional}"=="true"] 
    `description` 
endif::[] 
ifeval::["{optional}"=="false"] 
    *`description`* 
endif::[] 
|`String` 
|Description of the new Axis 
|true 

| 
ifeval::["{optional}"=="true"] 
    `tags[]` 
endif::[] 
ifeval::["{optional}"=="false"] 
    *`tags[]`* 
endif::[] 
|`TagDto[]` 
|Hierarchical view of axis' tags 
|false 

| 
ifeval::["{optional}"=="true"] 
    `tags[].id` 
endif::[] 
ifeval::["{optional}"=="false"] 
    *`tags[].id`* 
endif::[] 
|`Number` 
|Id of the tag 
|false 

| 
ifeval::["{optional}"=="true"] 
    `tags[].name` 
endif::[] 
ifeval::["{optional}"=="false"] 
    *`tags[].name`* 
endif::[] 
|`String` 
|Name of the tag 
|false 

| 
ifeval::["{optional}"=="true"] 
    `tags[].children` 
endif::[] 
ifeval::["{optional}"=="false"] 
    *`tags[].children`* 
endif::[] 
|`TagDto[]` 
|Child tags for this tag, if any 
|true 

|=== 

Answer 1

Das Problem in Ihrer benutzerdefinierten Vorlage, wo Sie {optional} statt {{optional}} in den ifeval Makros verwenden. Dies bedeutet, dass {optional} nicht durch das Feld optional des Felds ersetzt wird. Daher wertet Asciidoctor entweder "{optional}"=="true" oder aus.

Sie benötigen eine Vorlage zu aktualisieren, verwenden {{optional}}:

|=== 
|Path|Type|Description|Optional 

{{#fields}} 
|{{#tableCellContent}} 
ifeval::["{{optional}}"=="true"] 
    `{{path}}` 
endif::[] 
ifeval::["{{optional}}"=="false"] 
    *`{{path}}`* 
endif::[] 
    {{/tableCellContent}} 
    |{{#tableCellContent}}`{{type}}`{{/tableCellContent}} 
    |{{#tableCellContent}}{{description}}{{/tableCellContent}} 
    |{{#tableCellContent}}{{optional}}{{/tableCellContent}} 

{{/fields}} 
|===