Document interface

Author: kaklakariada

src/main/java/com/github/kaklakariada/aws/lambda/controller/HeaderValue.java

@@ -23,6 +23,9 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Get the header value with the given name.
+ */
 @Retention(RUNTIME)
 @Target(PARAMETER)
 public @interface HeaderValue {

src/main/java/com/github/kaklakariada/aws/lambda/controller/LambdaController.java

@@ -17,5 +17,9 @@
  */
 package com.github.kaklakariada.aws.lambda.controller;
 
+/**
+ * Marker interface for lambda controllers. Controller must have exactly one
+ * method annotated with {@link RequestHandlerMethod}.
+ */
 public interface LambdaController {
 }

src/main/java/com/github/kaklakariada/aws/lambda/controller/PathParameter.java

@@ -23,6 +23,9 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Get the path parameter with the given name.
+ */
 @Retention(RUNTIME)
 @Target(PARAMETER)
 public @interface PathParameter {

src/main/java/com/github/kaklakariada/aws/lambda/controller/QueryStringParameter.java

@@ -23,6 +23,9 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Get the query string with the given name.
+ */
 @Retention(RUNTIME)
 @Target(PARAMETER)
 public @interface QueryStringParameter {

src/main/java/com/github/kaklakariada/aws/lambda/controller/RequestBody.java

@@ -23,6 +23,9 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Get the request body.
+ */
 @Retention(RUNTIME)
 @Target(PARAMETER)
 public @interface RequestBody {

src/main/java/com/github/kaklakariada/aws/lambda/controller/RequestHandlerMethod.java

@@ -23,6 +23,21 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+import com.amazonaws.services.lambda.runtime.Context;
+import com.github.kaklakariada.aws.lambda.model.request.ApiGatewayRequest;
+
+/**
+ * Marks a method of a {@link LambdaController} as the request handler.
+ * Supported method arguments:
+ * <ul>
+ * <li>Type {@link ApiGatewayRequest}
+ * <li>Type {@link Context}
+ * <li>Argument annotation {@link RequestBody}
+ * <li>Argument annotation {@link HeaderValue}
+ * <li>Argument annotation {@link PathParameter}
+ * <li>Argument annotation {@link QueryStringParameter}
+ * </ul>
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 public @interface RequestHandlerMethod {