Skip to content
This repository was archived by the owner on Dec 19, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion spring-auto-restdocs-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
</execution>
</executions>
<configuration>
<doclet>capital.scalable.jsondoclet.ExtractDocumentationAsJsonDoclet</doclet>
<doclet>capital.scalable.restdocs.jsondoclet.ExtractDocumentationAsJsonDoclet</doclet>
<docletArtifact>
<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-json-doclet</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson;
package capital.scalable.restdocs;

import capital.scalable.restdocs.jackson.misc.AuthorizationSnippet;
import capital.scalable.restdocs.jackson.misc.DescriptionSnippet;
import capital.scalable.restdocs.jackson.misc.MethodAndPathSnippet;
import capital.scalable.restdocs.jackson.misc.SectionSnippet;
import capital.scalable.restdocs.jackson.payload.JacksonRequestFieldSnippet;
import capital.scalable.restdocs.jackson.payload.JacksonResponseFieldSnippet;
import capital.scalable.restdocs.jackson.request.PathParametersSnippet;
import capital.scalable.restdocs.jackson.request.RequestParametersSnippet;
import capital.scalable.restdocs.misc.AuthorizationSnippet;
import capital.scalable.restdocs.misc.DescriptionSnippet;
import capital.scalable.restdocs.misc.MethodAndPathSnippet;
import capital.scalable.restdocs.misc.SectionSnippet;
import capital.scalable.restdocs.payload.JacksonRequestFieldSnippet;
import capital.scalable.restdocs.payload.JacksonResponseFieldSnippet;
import capital.scalable.restdocs.request.PathParametersSnippet;
import capital.scalable.restdocs.request.RequestParametersSnippet;
import org.springframework.restdocs.snippet.Snippet;

public abstract class AutoDocumentation {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson;
package capital.scalable.restdocs;

import static org.springframework.web.servlet.HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE;

import java.util.Map;

import capital.scalable.restdocs.jackson.constraints.ConstraintReader;
import capital.scalable.restdocs.jackson.javadoc.JavadocReader;
import capital.scalable.restdocs.jackson.misc.AuthorizationSnippet;
import capital.scalable.restdocs.constraints.ConstraintReader;
import capital.scalable.restdocs.javadoc.JavadocReader;
import capital.scalable.restdocs.misc.AuthorizationSnippet;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.restdocs.RestDocumentationContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.constraints;
package capital.scalable.restdocs.constraints;

import static java.util.Collections.emptyList;
import static java.util.Collections.singletonMap;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.constraints;
package capital.scalable.restdocs.constraints;

import java.util.List;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.constraints;
package capital.scalable.restdocs.constraints;

import static capital.scalable.restdocs.jackson.constraints.SkippableConstraintResolver
import static capital.scalable.restdocs.constraints.SkippableConstraintResolver
.MANDATORY_VALUE_ANNOTATIONS;
import static org.apache.commons.lang3.ArrayUtils.contains;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.constraints;
package capital.scalable.restdocs.constraints;

import java.util.List;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.constraints;
package capital.scalable.restdocs.constraints;

import static org.slf4j.LoggerFactory.getLogger;
import static org.springframework.util.StringUtils.arrayToDelimitedString;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.constraints;
package capital.scalable.restdocs.constraints;

import javax.validation.constraints.NotNull;
import java.util.ArrayList;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.jackson;
package capital.scalable.restdocs.jackson;

import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.JsonMappingException;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,13 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.jackson;

import static capital.scalable.restdocs.jackson.jackson.FieldDocumentationVisitorWrapper.create;
package capital.scalable.restdocs.jackson;

import java.lang.reflect.Type;
import java.util.List;

import capital.scalable.restdocs.jackson.constraints.ConstraintReader;
import capital.scalable.restdocs.jackson.javadoc.JavadocReader;
import capital.scalable.restdocs.constraints.ConstraintReader;
import capital.scalable.restdocs.javadoc.JavadocReader;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectWriter;
Expand All @@ -48,7 +46,8 @@ public List<FieldDescriptor> generateDocumentation(Type type, TypeFactory typeFa
}

public List<FieldDescriptor> generateDocumentation(JavaType type) throws JsonMappingException {
FieldDocumentationVisitorWrapper visitorWrapper = create(javadocReader, constraintReader);
FieldDocumentationVisitorWrapper visitorWrapper = FieldDocumentationVisitorWrapper.create(
javadocReader, constraintReader);
writer.acceptJsonFormatVisitor(type, visitorWrapper);
return visitorWrapper.getContext().getFields();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.jackson;
package capital.scalable.restdocs.jackson;

import static org.apache.commons.collections.IteratorUtils.toList;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.jackson;
package capital.scalable.restdocs.jackson;

import static capital.scalable.restdocs.jackson.constraints.ConstraintReader.CONSTRAINTS_ATTRIBUTE;
import static capital.scalable.restdocs.jackson.constraints.ConstraintReader.OPTIONAL_ATTRIBUTE;
import static capital.scalable.restdocs.jackson.util.FieldUtil.fromGetter;
import static capital.scalable.restdocs.jackson.util.FieldUtil.isGetter;
import static capital.scalable.restdocs.constraints.ConstraintReader.CONSTRAINTS_ATTRIBUTE;
import static capital.scalable.restdocs.constraints.ConstraintReader.OPTIONAL_ATTRIBUTE;
import static capital.scalable.restdocs.util.FieldUtil.fromGetter;
import static capital.scalable.restdocs.util.FieldUtil.isGetter;
import static org.apache.commons.lang3.StringUtils.isBlank;
import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;

import java.util.ArrayList;
import java.util.List;

import capital.scalable.restdocs.jackson.constraints.ConstraintReader;
import capital.scalable.restdocs.jackson.javadoc.JavadocReader;
import capital.scalable.restdocs.constraints.ConstraintReader;
import capital.scalable.restdocs.javadoc.JavadocReader;
import org.springframework.restdocs.payload.FieldDescriptor;
import org.springframework.restdocs.snippet.Attributes.Attribute;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.jackson;
package capital.scalable.restdocs.jackson;

import capital.scalable.restdocs.jackson.constraints.ConstraintReader;
import capital.scalable.restdocs.jackson.javadoc.JavadocReader;
import capital.scalable.restdocs.constraints.ConstraintReader;
import capital.scalable.restdocs.javadoc.JavadocReader;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.SerializerProvider;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.jackson;
package capital.scalable.restdocs.jackson;

import java.lang.annotation.Annotation;
import java.util.List;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.jackson;
package capital.scalable.restdocs.jackson;

import static capital.scalable.restdocs.jackson.OperationAttributeHelper.initRequestPattern;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.setConstraintReader;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.setHandlerMethod;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.setJavadocReader;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.setObjectMapper;
import static capital.scalable.restdocs.OperationAttributeHelper.initRequestPattern;
import static capital.scalable.restdocs.OperationAttributeHelper.setConstraintReader;
import static capital.scalable.restdocs.OperationAttributeHelper.setHandlerMethod;
import static capital.scalable.restdocs.OperationAttributeHelper.setJavadocReader;
import static capital.scalable.restdocs.OperationAttributeHelper.setObjectMapper;

import capital.scalable.restdocs.jackson.constraints.ConstraintReaderImpl;
import capital.scalable.restdocs.jackson.javadoc.JavadocReaderImpl;
import capital.scalable.restdocs.constraints.ConstraintReaderImpl;
import capital.scalable.restdocs.javadoc.JavadocReaderImpl;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.ResultHandler;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package capital.scalable.restdocs.jackson.jackson;
package capital.scalable.restdocs.jackson;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.javadoc;
package capital.scalable.restdocs.javadoc;

import static org.springframework.util.StringUtils.hasText;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.javadoc;
package capital.scalable.restdocs.javadoc;

public interface JavadocReader {
String resolveFieldComment(Class<?> javaBaseClass, String javaFieldName);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.javadoc;
package capital.scalable.restdocs.javadoc;

import static org.slf4j.LoggerFactory.getLogger;
import static org.springframework.util.StringUtils.hasText;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.misc;
package capital.scalable.restdocs.misc;

import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getAuthorization;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.setAuthorization;
import static capital.scalable.restdocs.OperationAttributeHelper.getAuthorization;
import static capital.scalable.restdocs.OperationAttributeHelper.setAuthorization;

import java.util.HashMap;
import java.util.Map;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.misc;
package capital.scalable.restdocs.misc;

import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getHandlerMethod;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getJavadocReader;
import static capital.scalable.restdocs.OperationAttributeHelper.getHandlerMethod;
import static capital.scalable.restdocs.OperationAttributeHelper.getJavadocReader;

import java.util.HashMap;
import java.util.Map;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.misc;
package capital.scalable.restdocs.misc;

import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getRequestMethod;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getRequestPattern;
import static capital.scalable.restdocs.OperationAttributeHelper.getRequestMethod;
import static capital.scalable.restdocs.OperationAttributeHelper.getRequestPattern;

import java.util.HashMap;
import java.util.Map;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.misc;
package capital.scalable.restdocs.misc;

import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getDocumentationContext;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getHandlerMethod;
import static capital.scalable.restdocs.OperationAttributeHelper.getDocumentationContext;
import static capital.scalable.restdocs.OperationAttributeHelper.getHandlerMethod;
import static org.apache.commons.lang3.StringUtils.join;
import static org.apache.commons.lang3.StringUtils.splitByCharacterTypeCamelCase;
import static org.springframework.util.StringUtils.capitalize;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.payload;
package capital.scalable.restdocs.payload;

import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getConstraintReader;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getJavadocReader;
import static capital.scalable.restdocs.jackson.OperationAttributeHelper.getObjectMapper;
import static capital.scalable.restdocs.OperationAttributeHelper.getConstraintReader;
import static capital.scalable.restdocs.OperationAttributeHelper.getJavadocReader;
import static capital.scalable.restdocs.OperationAttributeHelper.getObjectMapper;

import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import capital.scalable.restdocs.jackson.constraints.ConstraintReader;
import capital.scalable.restdocs.jackson.jackson.FieldDocumentationGenerator;
import capital.scalable.restdocs.jackson.javadoc.JavadocReader;
import capital.scalable.restdocs.jackson.snippet.StandardTableSnippet;
import capital.scalable.restdocs.constraints.ConstraintReader;
import capital.scalable.restdocs.jackson.FieldDocumentationGenerator;
import capital.scalable.restdocs.javadoc.JavadocReader;
import capital.scalable.restdocs.snippet.StandardTableSnippet;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.core.MethodParameter;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.payload;
package capital.scalable.restdocs.payload;

public class JacksonFieldProcessingException extends RuntimeException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.payload;
package capital.scalable.restdocs.payload;

import java.lang.reflect.GenericArrayType;
import java.lang.reflect.Type;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package capital.scalable.restdocs.jackson.payload;
package capital.scalable.restdocs.payload;

import java.lang.reflect.GenericArrayType;
import java.lang.reflect.Type;
Expand Down
Loading