doc: comment 정리

dev
gitea-관리자 1 year ago
parent f9a7913350
commit e5799b86ea

@ -6,16 +6,16 @@ import org.egovframe.rte.psl.dataaccess.mapper.Mapper;
/**
* <pre>
* description :
* description : API mapper
*
* packageName : kr.xit.biz.ens.mapper
* fileName : IKkoMyDocMapper
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -11,16 +11,16 @@ import lombok.*;
/**
* <pre>
* description : tb_ens_ Entity DTO
* description : DTO
*
* packageName : kr.xit.biz.ens.model
* fileName : KkoMyDocDTO
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -2,7 +2,6 @@
* ENS business packages
* <p>
* : ens
* sms
* </p>
* @since 1.0
* @author limju

@ -5,16 +5,16 @@ import kr.xit.core.model.ApiResponseDTO;
/**
* <pre>
* description :
* description : API Service Interface
*
* packageName : kr.xit.biz.ens.service
* fileName : IKkoMyDocService
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -16,16 +16,16 @@ import lombok.RequiredArgsConstructor;
/**
* <pre>
* description : ()
* description : API Service
*
* packageName : kr.xit.biz.ens.service
* fileName : KkoMyDocService
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -14,20 +14,20 @@ import org.springframework.web.bind.annotation.RestController;
/**
* <pre>
* description :
* description : API Controller
*
* packageName : kr.xit.biz.ens.web
* fileName : KkoMyDocController
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/
@Tag(name = "KkoMyDocController", description = "카카오페이 전자문서 콘텐츠 조회")
@Tag(name = "KkoMyDocController", description = "카카오페이 전자문서 API Controller")
@RequiredArgsConstructor
@RestController
@RequestMapping(value = "/api/ens/v1")

@ -21,11 +21,11 @@ import lombok.experimental.SuperBuilder;
* packageName : kr.xit.core.biz.model
* fileName : AuditFields
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -67,19 +67,24 @@ public class AuthApiController {
* @param request HttpServletRequest
* @return ()
*/
@Operation(summary = "로그인" , description = "로그인")
@io.swagger.v3.oas.annotations.parameters.RequestBody(
required = true,
content = {
@Content(
mediaType = "application/json",
examples = {
@ExampleObject(
value = "{\"id\":\"admin\",\"password\":\"1\",\"userSe\":\"USR\"}")
@ExampleObject(value = """
{
"id": "admin",
"password": "1",
"userSe": "USR"
}
""")
}
)
}
)
@Operation(summary = "로그인" , description = "로그인")
@PostMapping(value = "/login", consumes = {MediaType.APPLICATION_JSON_VALUE , MediaType.TEXT_HTML_VALUE})
public ApiResponseDTO<?> login(@RequestBody final LoginVO loginVO, HttpServletRequest request) {
// 1. 일반 로그인 처리
@ -92,7 +97,6 @@ public class AuthApiController {
return ApiResponseDTO.success(egovMessageSource.getMessage("fail.common.login"));
}
@Operation(summary = "로그인(JWT)" , description = "로그인(JWT)")
@io.swagger.v3.oas.annotations.parameters.RequestBody(
required = true,
content = {
@ -102,19 +106,28 @@ public class AuthApiController {
@ExampleObject(
name = "admin",
description = "admin",
value = "{\"id\":\"admin\",\"password\":\"1\",\"userSe\":\"USR\"}"),
value = """
{
"id": "admin",
"password": "1",
"userSe": "USR"
}
"""),
@ExampleObject(
name = "admin1",
description = "admin1",
value = "{\"id\":\"admin1\",\"password\":\"1\",\"userSe\":\"USR\"}"),
@ExampleObject(
name = "admin2",
description = "admin2",
value = "{\"id\":\"admin2\",\"password\":\"1\",\"userSe\":\"USR\"}")
value = """
{
"id": "admin1",
"password": "1",
"userSe": "USR"
}
""")
}
)
}
)
@Operation(summary = "로그인(JWT)" , description = "로그인(JWT)")
@PostMapping(value = "/loginJwt")
public ApiResponseDTO<?> loginJWT(@RequestBody final LoginVO loginVO, HttpServletRequest request) {
HashMap<String, Object> resultMap = new HashMap<String, Object>();

@ -17,11 +17,11 @@ import kr.xit.biz.ens.model.EnsDTO;
* packageName : kr.xit.biz.ens.mapper
* fileName : IEnsBatchMapper
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -14,11 +14,11 @@ import lombok.experimental.SuperBuilder;
* packageName : kr.xit.biz.ens.model
* fileName : CntcDTO
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -23,11 +23,11 @@ import javax.validation.constraints.Size;
* packageName : kr.xit.biz.ens.model
* fileName : EnsDTO
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -51,11 +51,11 @@ import javax.validation.Validator;
* packageName : kr.xit.biz.ens.service
* fileName : EnsBatchService
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -11,11 +11,11 @@ import kr.xit.biz.ens.model.EnsDTO;
* packageName : kr.xit.biz.ens.service
* fileName : IEnsBatchService
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -30,11 +30,11 @@ import org.springframework.web.bind.annotation.RestController;
* packageName : kr.xit.biz.ens.web
* fileName : SendMessageLinkController
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/
@ -63,32 +63,36 @@ public class ApiCallTestController {
* @param reqDTO
* @return ResponseEntity
*/
@Operation(summary = "문서발송 요청", description = "카카오페이 전자문서 서버로 문서발송 처리를 요청")
@io.swagger.v3.oas.annotations.parameters.RequestBody(required = true, content = {
@Content(mediaType = "application/json", examples = {
@ExampleObject(value = "{\"document\": {\n"
+ " \"title\": \"문서 제목\",\n"
+ " \"read_expired_sec\": 3600,\n"
+ " \"hash\": \"6EFE827AC88914DE471C621AE\",\n"
+ " \"common_categories\": [\n"
+ " \"NOTICE\"\n"
+ " ],\n"
+ " \"receiver\": {\n"
+ " \"phone_number\": \"01093414345\",\n"
+ " \"name\": \"김지호\",\n"
+ " \"birthday\": \"19831218\",\n"
+ " \"is_required_verify_name\": false\n"
+ " },\n"
+ " \"property\": {\n"
+ " \"link\": \"http://ip:8081/api/kakaopay/v1/ott\",\n"
+ " \"cs_number\": \"02-123-4567\",\n"
+ " \"cs_name\": \"콜센터\",\n"
+ " \"payload\": \"payload 파라미터 입니다.\",\n"
+ " \"message\": \"해당 안내문은 다음과 같습니다.\"\n"
+ " }\n"
+ " }}")
@ExampleObject(value = """
{
"document": {
"title": "문서 제목",
"read_expired_sec": 3600,
"hash": "6EFE827AC88914DE471C621AE",
"common_categories": [
"NOTICE"
],
"receiver": {
"phone_number": "01093414345",
"name": "김지호",
"birthday": "19831218",
"is_required_verify_name": false
},
"property": {
"link": "http://ip:8081/api/kakaopay/v1/ott",
"cs_number": "02-123-4567",
"cs_name": "콜센터",
"payload": "payload 파라미터 입니다.",
"message": "해당 안내문은 다음과 같습니다."
}
}
}
""")
})
})
@Operation(summary = "문서발송 요청", description = "카카오페이 전자문서 서버로 문서발송 처리를 요청")
@PostMapping(value = "/documents", produces = MediaType.APPLICATION_JSON_VALUE)
public ApiResponseDTO<?> requestSend(
@RequestBody final SendRequest reqDTO
@ -116,32 +120,34 @@ public class ApiCallTestController {
@Operation(summary = "대량 문서발송 요청", description = "카카오페이 전자문서 서버로 대량 문서발송 처리를 요청")
@io.swagger.v3.oas.annotations.parameters.RequestBody(required = true, content = {
@Content(mediaType = "application/json", examples = {
@ExampleObject(value = "{\n"
+ " \"documents\": [\n"
+ " {\n"
+ " \"title\": \"문서 제목\",\n"
+ " \"read_expired_sec\": 3600,\n"
+ " \"hash\": \"6EFE827AC88914DE471C621AE\",\n"
+ " \"common_categories\": [\n"
+ " \"NOTICE\"\n"
+ " ],\n"
+ " \"receiver\": {\n"
+ " \"phone_number\": \"01093414345\",\n"
+ " \"name\": \"김지호\",\n"
+ " \"birthday\": \"19831218\",\n"
+ " \"is_required_verify_name\": false\n"
+ " },\n"
+ " \"property\": {\n"
+ " \"link\": \"http://ip:8081/api/kakaopay/v1/ott\",\n"
+ " \"cs_number\": \"02-123-4567\",\n"
+ " \"cs_name\": \"콜센터\",\n"
+ " \"payload\": \"payload 파라미터 입니다.\",\n"
+ " \"message\": \"해당 안내문은 다음과 같습니다.\",\n"
+ " \"external_document_uuid\": \"A000001\"\n"
+ " }\n"
+ " }\n"
+ " ]\n"
+ "}")
@ExampleObject(value = """
{
"documents": [
{
"title": "문서 제목",
"read_expired_sec": 3600,
"hash": "6EFE827AC88914DE471C621AE",
"common_categories": [
"NOTICE"
],
"receiver": {
"phone_number": "01093414345",
"name": "김지호",
"birthday": "19831218",
"is_required_verify_name": false
},
"property": {
"link": "http://ip:8081/api/kakaopay/v1/ott",
"cs_number": "02-123-4567",
"cs_name": "콜센터",
"payload": "payload 파라미터 입니다.",
"message": "해당 안내문은 다음과 같습니다.",
"external_document_uuid": "A000001"
}
}
]
}
""")
})
})
@PostMapping(value = "/documents/bulk", produces = MediaType.APPLICATION_JSON_VALUE)
@ -168,11 +174,13 @@ public class ApiCallTestController {
*/
@io.swagger.v3.oas.annotations.parameters.RequestBody(required = true, content = {
@Content(mediaType = "application/json", examples = {
@ExampleObject(value = "{\n"
+ " \"document_binder_uuids\": [\n"
+ " \"BIN-883246dbff7b11edb3bb7affed8a016d\"\n"
+ " ]\n"
+ "}")
@ExampleObject(value = """
{
"document_binder_uuids": [
"BIN-883246dbff7b11edb3bb7affed8a016d"
]
}
""")
})
})
@Operation(summary = "대량 문서 상태 조회 요청", description = "카카오페이 전자문서 서버로 대량 문서 상태 조회 요청")

@ -20,11 +20,11 @@ import lombok.RequiredArgsConstructor;
* packageName : kr.xit.biz.ens.web
* fileName : EnsBatchController
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -21,11 +21,11 @@ import lombok.experimental.SuperBuilder;
* packageName : kr.xit.core.biz.model
* fileName : AuditFields
* author : limju
* date : 2023-06-05
* date : 2023-08-31
* ======================================================================
*
* ----------------------------------------------------------------------
* 2023-06-05 limju
* 2023-08-31 limju
*
* </pre>
*/

@ -24,7 +24,7 @@ logging:
level:
root: debug
file:
path: D:/data/ens/logs
path: D:/data/mens/logs
```
### SQL 로그 : p6spy 또는 log4jdbc
```yml

@ -275,7 +275,7 @@ public class BouncyUtils {
// TODO::암호화할 속성
public static void main(String[] args) throws Exception {
String path = "d:/data/ens/.pem/";
String path = "d:/data/mens/.pem/";
String macAddress = "00-21-5E-DB-59-36"; //dev mac IpMacUtils.getMacAddress("ip");
//String macAddress = "FC-34-97-15-04-44"; //local mac
String key = "mxLAM1fAEDPWkFz8";

@ -291,8 +291,8 @@ public class SFTPUtils {
System.out.println(fileNameList);
sftpUtil.mv(
"/data/ens/sg-pni-cctv/err/20230622111301_49고3736_174번카메라-UDP_101.jpg",
"/data/ens/sg-pni-cctv/rcv/20230622111301_49고3736_174번카메라-UDP_101.jpg"
"/data/mens/sg-pni-cctv/err/20230622111301_49고3736_174번카메라-UDP_101.jpg",
"/data/mens/sg-pni-cctv/rcv/20230622111301_49고3736_174번카메라-UDP_101.jpg"
);
}catch(Exception e) {

Loading…
Cancel
Save