Add documentation

Author: Matheus Cruz

moqu/core/src/main/java/io/quarkiverse/openapi/moqu/Moqu.java

@@ -1,27 +1,37 @@
 package io.quarkiverse.openapi.moqu;
 
+import io.quarkiverse.openapi.moqu.model.RequestResponsePair;
+
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 
-import io.quarkiverse.openapi.moqu.model.RequestResponsePair;
-import io.quarkiverse.openapi.moqu.model.Request;
-import io.quarkiverse.openapi.moqu.model.Response;
-
 /**
- * Moqu represents all {@link Request} and {@link Response}
- * pair list.
+ * Represents a collection of request-response pairs, providing methods to access
+ * these pairs in an immutable list.
  */
 public class Moqu {
 
     private List<RequestResponsePair> requestResponsePairs = new ArrayList<>();
 
+    /**
+     * Constructs a {@code Moqu} instance with the provided list of request-response pairs.
+     *
+     * @param requestResponsePairs the list of {@link RequestResponsePair} objects to initialize
+     *        the collection. Must not be {@code null}.
+     * @throws NullPointerException if {@code requestResponsePairs} is null.
+     */
     public Moqu(List<RequestResponsePair> requestResponsePairs) {
         this.requestResponsePairs = Objects.requireNonNull(requestResponsePairs);
     }
 
+    /**
+     * Returns an unmodifiable list of request-response pairs.
+     *
+     * @return an immutable list of {@link RequestResponsePair}.
+     */
     public List<RequestResponsePair> getRequestResponsePairs() {
         return Collections.unmodifiableList(requestResponsePairs);
     }
-}
+}

moqu/core/src/main/java/io/quarkiverse/openapi/moqu/MoquImporter.java

@@ -1,13 +1,17 @@
 package io.quarkiverse.openapi.moqu;
 
 /**
- * {@link MoquImporter} aims to convert an specification {@link Moqu} model.
+ * {@link MoquImporter} aims to convert a specification into a {@link Moqu} model.
+ * It provides a method to parse the content, typically from an OpenAPI specification,
+ * and generate a corresponding {@link Moqu} instance.
  */
 public interface MoquImporter {
 
     /**
-     * @param content OpenAPI content
-     * @return A new {@link Moqu} instance
+     * Parses the provided OpenAPI content and generates a new {@link Moqu} instance.
+     *
+     * @param content the OpenAPI content as a string, which will be parsed into a {@link Moqu} model.
+     * @return a new {@link Moqu} instance based on the provided content.
      */
     Moqu parse(String content);
-}
+}

moqu/core/src/main/java/io/quarkiverse/openapi/moqu/MoquMapper.java

@@ -2,7 +2,18 @@
 
 import java.util.List;
 
+/**
+ * A generic interface for mapping a {@link Moqu} instance to a list of objects of type {@code T}.
+ *
+ * @param <T> the type of objects to which the {@link Moqu} instance will be mapped.
+ */
 public interface MoquMapper<T> {
 
-    List<T> map(Moqu mock);
-}
+    /**
+     * Maps the given {@link Moqu} instance to a list of objects of type {@code T}.
+     *
+     * @param moqu the {@link Moqu} instance to be mapped.
+     * @return a list of mapped objects of type {@code T}.
+     */
+    List<T> map(Moqu moqu);
+}

moqu/core/src/main/java/io/quarkiverse/openapi/moqu/ParameterType.java

@@ -1,17 +1,43 @@
 package io.quarkiverse.openapi.moqu;
 
+/**
+ * Enum representing the type of a parameter in an HTTP request, indicating its location.
+ * The parameter can be part of the path, query string, or headers.
+ */
 public enum ParameterType {
+
+    /**
+     * Indicates that the parameter is part of the URL path.
+     */
     PATH("path"),
+
+    /**
+     * Indicates that the parameter is part of the query string.
+     */
     QUERY("query"),
+
+    /**
+     * Indicates that the parameter is part of the HTTP headers.
+     */
     HEADER("header");
 
     private final String value;
 
+    /**
+     * Constructs a {@code ParameterType} with the given string value representing the parameter location.
+     *
+     * @param value the string value corresponding to the parameter type.
+     */
     ParameterType(String value) {
         this.value = value;
     }
 
+    /**
+     * Returns the string value associated with this {@code ParameterType}.
+     *
+     * @return the string representation of the parameter type.
+     */
     public String value() {
         return this.value;
     }
-}
+}

moqu/core/src/main/java/io/quarkiverse/openapi/moqu/SchemaReader.java

@@ -1,20 +1,31 @@
 package io.quarkiverse.openapi.moqu;
 
-import static io.swagger.v3.parser.util.SchemaTypeUtil.OBJECT_TYPE;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import io.quarkiverse.openapi.moqu.marshall.ObjectMapperFactory;
+import io.swagger.v3.oas.models.media.Schema;
 
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-
-import io.quarkiverse.openapi.moqu.marshall.ObjectMapperFactory;
-import io.swagger.v3.oas.models.media.Schema;
+import static io.swagger.v3.parser.util.SchemaTypeUtil.OBJECT_TYPE;
 
+/**
+ * Utility class for reading schema examples and converting them into JSON representations.
+ * This class provides methods to extract example data from a given schema and serialize it
+ * into JSON format.
+ */
 public class SchemaReader {
 
     static String EMPTY_JSON_OBJECT = "{}";
 
+    /**
+     * Reads the example object from the provided schema and converts it to a JSON string.
+     *
+     * @param schema the schema from which to extract the example object.
+     * @return a JSON string representation of the example object, or an empty JSON object
+     *         if an error occurs during processing.
+     */
     static String readObjectExample(Schema<?> schema) {
         try {
             Map<String, Object> map = mapObjectExample(schema);
@@ -24,6 +35,12 @@ static String readObjectExample(Schema<?> schema) {
         }
     }
 
+    /**
+     * Recursively maps the properties of the provided schema to a map.
+     *
+     * @param schema the schema from which to map properties.
+     * @return a map representing the example properties of the schema.
+     */
     private static Map<String, Object> mapObjectExample(Schema<?> schema) {
         Map<String, Object> currentRoot = new HashMap<>();
 
@@ -43,4 +60,4 @@ private static Map<String, Object> mapObjectExample(Schema<?> schema) {
 
         return currentRoot;
     }
-}
+}