Added javadoc

This commit is contained in:
gmod11
2021-01-05 18:53:14 +01:00
parent bc0ba7ec9f
commit d64acde129
7 changed files with 57 additions and 8 deletions

View File

@@ -9,6 +9,9 @@ import springfox.documentation.swagger2.annotations.EnableSwagger2;
import static springfox.documentation.builders.PathSelectors.regex;
/**
* Points to swagger version and package containing controller classes
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {

View File

@@ -18,6 +18,10 @@ import java.util.LinkedList;
import java.util.List;
import java.util.UUID;
/**
* Class responds to request asking about history of messages.
*/
@Slf4j
@Controller
@RequestMapping

View File

@@ -22,6 +22,11 @@ import java.util.Map;
import java.util.Objects;
import java.util.UUID;
/**
* A class responds to generated message uri's requests.
* It deletes or fetches the requested message
*/
@Controller("/")
@Slf4j
//@Profile({"DEV", "default"})

View File

@@ -20,6 +20,12 @@ import java.net.InetAddress;
import java.time.LocalDateTime;
import java.util.*;
/**
* Sending GET request to path /home sets up a new UUID ex. 58b9709d-358b-4713-8fbc-6acf89e81418
* UUID is something like session id type which contains references to each saved message
* Next saved massage shares UUID but its id is a +1 ex.
* 58b9709d-358b-4713-8fbc-6acf89e81418/1; 58b9709d-358b-4713-8fbc-6acf89e81418/2 etc.
*/
@Slf4j
@Controller
@RequestMapping

View File

@@ -9,6 +9,9 @@ import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime;
import java.util.UUID;
/**
* Pojo for client request
*/
@Data
@Builder
@NoArgsConstructor

View File

@@ -8,6 +8,11 @@ import javax.validation.constraints.Positive;
import java.util.Map;
import java.util.UUID;
/**
* it appears that instance of this class contains info about mocked response
* To which UUID it is bound, whats its id, the list of headers, type of content and message body,
* as well as status it has to return.
*/
@Data
@Builder
@ToString