Skip to content

Commit

Permalink
api docs jar 미포함 문제 수정 및 docs 작성 (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
Juhongseok authored Oct 27, 2023
1 parent b9030b7 commit 3842304
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/Deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
- name: Build with Gradle
uses: gradle/gradle-build-action@bd5760595778326ba7f1441bcf7e88b49de61a25
with:
arguments: build
arguments: bootJar

- name: Make Zip File
run: zip -qq -r ./$GITHUB_SHA.zip .
Expand Down
7 changes: 7 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,10 @@ asciidoctor {
build {
dependsOn copyDocument
}

bootJar {
dependsOn copyDocument
from ("${asciidoctor.outputDir}") {
into 'static/docs'
}
}
23 changes: 21 additions & 2 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ endif::[]

// filename은 src/test/java/o.d.r/common/DocumentLinkGenerator#DocUrl
// 필드 중 htmlFileName과 동일한 이름을 주면 됩니다
== 첨삭 이벤트
= 첨삭 이벤트
== 생성
=== Request
include::{snippets}/event/create/http-request.adoc[]
include::{snippets}/event/create/request-fields.adoc[]
Expand All @@ -26,7 +27,25 @@ include::{snippets}/event/create/request-fields.adoc[]
include::{snippets}/event/create/http-response.adoc[]
include::{snippets}/event/create/response-fields.adoc[]

== 이력서
== 신청
=== Request
include::{snippets}/event/apply/http-request.adoc[]
include::{snippets}/event/apply/request-fields.adoc[]

=== Response
include::{snippets}/event/apply/http-response.adoc[]
include::{snippets}/event/apply/response-fields.adoc[]

== 반려
=== Request
include::{snippets}/event/reject/http-request.adoc[]
include::{snippets}/event/reject/request-fields.adoc[]

=== Response
include::{snippets}/event/reject/http-response.adoc[]

= 이력서
== 생성
=== Request
include::{snippets}/resume/create/http-request.adoc[]
include::{snippets}/resume/create/request-fields.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,7 @@ public class SecurityConfig {

@Bean
public WebSecurityCustomizer webSecurityCustomizer(){
return web -> {
web.ignoring()
.requestMatchers("/docs/index.html");
};
return web -> web.ignoring().requestMatchers("/docs/index.html");
}

@Bean
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/application-endpoint.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
endpoint:
permit-all:
get: /docs/index.html
get:
post:
put:
patch:
Expand Down

0 comments on commit 3842304

Please sign in to comment.