fixed pipe escaping in tables (#160)

Author: jmisur

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/snippet/StandardTableSnippet.java

@@ -140,7 +140,7 @@ private String joinAndFormat(String description, List<String> constraints,
 
         res.append(constr.toString());
 
-        return res.toString();
+        return res.toString().replace("|", "\\|");
     }
 
     private StringBuilder formatConstraints(List<String> constraints, String forcedLineBreak) {

spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/payload/JacksonResponseFieldSnippetTest.java

@@ -230,7 +230,23 @@ public void failOnUndocumentedFields() throws Exception {
                 .build());
     }
 
+    @Test
+    public void escaping() throws Exception {
+        HandlerMethod handlerMethod = createHandlerMethod("processItem");
+        mockFieldComment(ProcessingResponse.class, "output", "An output | result");
 
+        this.snippets.expect(RESPONSE_FIELDS).withContents(
+                tableWithHeader("Path", "Type", "Optional", "Description")
+                        .row("output", "String", "true", "An output \\| result."));
+
+        new JacksonResponseFieldSnippet().responseBodyAsType(ProcessingResponse.class)
+                .document(operationBuilder
+                        .attribute(HandlerMethod.class.getName(), handlerMethod)
+                        .attribute(ObjectMapper.class.getName(), mapper)
+                        .attribute(JavadocReader.class.getName(), javadocReader)
+                        .attribute(ConstraintReader.class.getName(), constraintReader)
+                        .build());
+    }
     private void mockConstraintMessage(Class<?> type, String fieldName, String comment) {
         when(constraintReader.getConstraintMessages(type, fieldName))
                 .thenReturn(singletonList(comment));

spring-auto-restdocs-example/src/main/java/capital/scalable/restdocs/example/items/ItemResponse.java

@@ -70,7 +70,7 @@ class ItemResponse {
     private List<ItemResponse> children;
 
     /**
-     * Some information about the item.
+     * Some information | description about the item.
      */
     public String getDescription() {
         return desc;