Browse Source

add: FLT모듈 문서화 작성 추가

pull/9/head
lkd9125(이경도) 7 months ago
parent
commit
2fc7e58bd1
  1. 153
      app/kac-app/src/docs/asciidoc/index.adoc
  2. 3618
      app/kac-app/src/main/resources/static/docs/index.html
  3. 2
      app/kac-app/src/test/java/kr/co/palnet/kac/flt/laanc/FlightLaancControllerTest.java

153
app/kac-app/src/docs/asciidoc/index.adoc

@ -11,7 +11,7 @@ API 문서
:toclevels: 2
:sectlinks:
[[Common-Code-API]]
[[Common-API]]
== Common-Code API
[[Code-All]]
@ -174,7 +174,7 @@ include::{snippets}/com/code/lang/delete/http-response.adoc[]
***
[[User-Account-API]]
[[User-API]]
== User-Account API
=== [User 회원가입]
@ -241,4 +241,153 @@ include::{snippets}/user/account/update/request-fields.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/user/account/update/http-response.adoc[]
***
[[Flight-API]]
== Flight-Laanc API
=== [Laanc 비행계획서 생성]
==== [HTTP REQUEST INFO]
include::{snippets}/flight/laanc/create/plan/http-request.adoc[]
include::{snippets}/flight/laanc/create/plan/request-headers.adoc[]
include::{snippets}/flight/laanc/create/plan/request-fields.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/flight/laanc/create/plan/http-response.adoc[]
include::{snippets}/flight/laanc/create/plan/response-fields.adoc[]
***
=== [TS QR 코드 생성]
==== [HTTP REQUEST INFO]
include::{snippets}/flight/laanc/ts/qr/http-request.adoc[]
include::{snippets}/flight/laanc/ts/qr/request-headers.adoc[]
include::{snippets}/flight/laanc/ts/qr/request-fields.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/flight/laanc/ts/qr/http-response.adoc[]
include::{snippets}/flight/laanc/ts/qr/response-fields.adoc[]
***
=== [TS QR 코드 확인]
==== [HTTP REQUEST INFO]
include::{snippets}/flight/laanc/ts/qr/confirm/http-request.adoc[]
include::{snippets}/flight/laanc/ts/qr/confirm/request-headers.adoc[]
include::{snippets}/flight/laanc/ts/qr/confirm/path-parameters.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/flight/laanc/ts/qr/confirm/http-response.adoc[]
include::{snippets}/flight/laanc/ts/qr/confirm/response-fields.adoc[]
***
=== [공역(금지구역) 체크]
==== [HTTP REQUEST INFO]
include::{snippets}/flight/laanc/valid/duplicated/airspace/http-request.adoc[]
include::{snippets}/flight/laanc/valid/duplicated/airspace/request-headers.adoc[]
include::{snippets}/flight/laanc/valid/duplicated/airspace/request-fields.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/flight/laanc/valid/duplicated/airspace/http-response.adoc[]
include::{snippets}/flight/laanc/valid/duplicated/airspace/response-fields.adoc[]
***
=== [허용고도 조회]
==== [HTTP REQUEST INFO]
include::{snippets}/flight/laanc/valid/elev/http-request.adoc[]
include::{snippets}/flight/laanc/valid/elev/request-headers.adoc[]
include::{snippets}/flight/laanc/valid/elev/request-fields.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/flight/laanc/valid/elev/http-response.adoc[]
include::{snippets}/flight/laanc/valid/elev/response-fields.adoc[]
***
=== [LAANC 승인 목록]
==== [HTTP REQUEST INFO]
include::{snippets}/flight/laanc/list/http-request.adoc[]
include::{snippets}/flight/laanc/list/request-headers.adoc[]
include::{snippets}/flight/laanc/list/query-parameters.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/flight/laanc/list/http-response.adoc[]
include::{snippets}/flight/laanc/list/response-fields.adoc[]
***
=== [LAANC 승인 상세 조회]
==== [HTTP REQUEST INFO]
include::{snippets}/flight/laanc/detail/http-request.adoc[]
include::{snippets}/flight/laanc/detail/request-headers.adoc[]
include::{snippets}/flight/laanc/detail/path-parameters.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/flight/laanc/detail/http-response.adoc[]
include::{snippets}/flight/laanc/detail/response-fields.adoc[]
***
== Flight-Plan API
=== [비행 계획서 작성 - 버퍼존 생성]
==== [HTTP REQUEST INFO]
include::{snippets}/flight/plan/area/buffer/http-request.adoc[]
include::{snippets}/flight/plan/area/buffer/request-headers.adoc[]
include::{snippets}/flight/plan/area/buffer/request-fields.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/flight/plan/area/buffer/http-response.adoc[]
include::{snippets}/flight/plan/area/buffer/response-fields.adoc[]
***
=== [비행 운항 스케줄 조회]
==== [HTTP REQUEST INFO]
include::{snippets}/flight/plan/schedule/http-request.adoc[]
include::{snippets}/flight/plan/schedule/request-headers.adoc[]
include::{snippets}/flight/plan/schedule/query-parameters.adoc[]
==== [HTTP RESPONSE INFO]
include::{snippets}/flight/plan/schedule/http-response.adoc[]
include::{snippets}/flight/plan/schedule/response-fields.adoc[]
***

3618
app/kac-app/src/main/resources/static/docs/index.html

File diff suppressed because it is too large Load Diff

2
app/kac-app/src/test/java/kr/co/palnet/kac/flt/laanc/FlightLaancControllerTest.java

@ -293,7 +293,7 @@ public class FlightLaancControllerTest extends BaseTest {
.andExpect(status().isOk());
}
@DisplayName("공역(금지구역) 체크")
@DisplayName("허용고도 조회")
@Test
@Transactional
public void getAllowableElevation() throws Exception{

Loading…
Cancel
Save