我需要记录一个API,它接受由这个类表示的JSON:
public class Message {
@NotNull(message = "Sender cannot be null")
private String sender;
@Pattern(regexp="HI|HELLO",message = "Message can be only 'HI' or 'HELLO'")
private String content;
// Constructor, Getters and Setters..
}Spring Docs自动生成以下代码片段:
.Request fields:
|===
|Path|Type|Constraints|Description
|sender
|String
|Must not be null
|Sender of the message
|content
|String
|Must match the regular expression `HI|HELLO`
|Content of the message
|===它由Asciidoctor用来在pdf中创建表。然而,在pdf中,表格被破坏了(因为管道):

如何转义正则表达式中的管道?
我找到了这个issue,但似乎与另一个项目有关。
这是生成文档的测试类(JUnit5):
@WebMvcTest(HomeController.class)
@AutoConfigureRestDocs(outputDir = "target/snippets")
public class HomeControllerTest {
@Autowired
private MockMvc mockMvc;
@Test
public void postMessageTest() throws Exception {
ConstrainedFields constrainedFields = new ConstrainedFields(Message.class);
this.mockMvc
.perform(post("/message").content("{\"sender\":\"Marc\",\"content\":\"HI\"}")
.characterEncoding("utf-8")
.contentType(MediaType.APPLICATION_JSON))
.andDo(print()).andExpect(status().isOk())
.andDo(document("home-message", requestFields(
attributes(key("title").value("Request fields:")),
constrainedFields.withPath("sender").description("Sender of the message"),
constrainedFields.withPath("content").description("Content of the message")
)));
}
private static class ConstrainedFields {
private final ConstraintDescriptions constraintDescriptions;
ConstrainedFields(Class<?> input) {
this.constraintDescriptions = new ConstraintDescriptions(input);
}
private FieldDescriptor withPath(String property) {
return fieldWithPath(property).attributes(key("constraints").value(
// Let's assume there is only one constraint for each property
constraintDescriptions.descriptionsForProperty(property).get(0)));
}
}
}重现该问题的完整项目是here。
发布于 2020-09-26 23:09:57
可能不是最好的解决方案,但是,在做了很少的研究之后,我发现在asciidoctor文档(source)中,一个简单的\字符足以转义竖线字符。然后,我们的目标是在.adoc代码片段中获得这一行:
|Must match the regular expression `HI\|HELLO`这是在你的代码中提取“约束描述”的方法:
private FieldDescriptor withPath(String property) {
return fieldWithPath(property).attributes(key("constraints").value(
// Let's assume there is only one constraint for each property
constraintDescriptions.descriptionsForProperty(property).get(0)));
}在这里,我们可以“完全控制”将在.adoc中编写的文本。例如,我们可以从constraintDescriptions.descriptionsForProperty(property)获取约束描述,应用转义,然后将转义字符串传递给.value()
private FieldDescriptor withPath(String property) {
// Let's assume there is only one constraint for each property
String desc = constraintDescriptions.descriptionsForProperty(property).get(0);
desc = desc.replace("|", "\\|");
return fieldWithPath(property).attributes(key("constraints").value(desc));
}这将在.adoc中生成转义行,并将在.pdf中正确呈现

https://stackoverflow.com/questions/64075493
复制相似问题