Skip to content

Commit

Permalink
📝docs : api docs 수정
Browse files Browse the repository at this point in the history
  • Loading branch information
DDonghyeo authored May 19, 2024
1 parent f408654 commit c660b92
Showing 1 changed file with 24 additions and 14 deletions.
38 changes: 24 additions & 14 deletions .github/workflows/apiDocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
- develop

jobs:
document:
api-docs-integration:
runs-on: ubuntu-latest
steps:

Expand All @@ -29,14 +29,13 @@ jobs:
# run : |
# redocly join ./noti.json ./user.json ./weather.json -o ./api.json

# Redoc : json 파일 join
- name: redoc-cli-github-action
uses: seeebiii/redoc-cli-github-action@v9
with:
args: 'join ./noti.json ./user.json ./weather.json -o ./api.json'
# # Redoc : json 파일 join
# - name: redoc-cli-github-action
# uses: seeebiii/redoc-cli-github-action@v9
# with:
# args: 'join ./noti.json ./user.json ./weather.json -o ./api.json'

- name: Change File Ownership
run: sudo chown --recursive --preserve-root --verbose runner:docker ./api.json


# - name : ls
# run : |
Expand All @@ -46,21 +45,32 @@ jobs:

# Redoc : json 파일 join
- name: redoc-cli-github-action
uses: seeebiii/redoc-cli-github-action@v9
uses: seeebiii/redoc-cli-github-action@v10
with:
args: 'bundle ./user.json ./noti.json ./weather.json --output ./index.html --ext html'
args: 'bundle ./user.json ./noti.json ./weather.json --output ./api.yaml --ext yaml'

- name: check result
run: |
ls -al
test -f api.yaml || (echo "Missing api.yaml from previous step." && exit 1)
# - name: Rename Yaml Title & Desc
# run: |
# cat ./api.yaml
# yq -i '.info.title = "Waither Backend API Document for FrontEnd"' ./api.yaml
# yq -i '.info.description = "Please contact Petstore backend if there are any issues with API"' ./api.yaml

# - name: redoc-cli-github-action
# uses: seeebiii/redoc-cli-github-action@v9
# with:
# args: 'build-docs ./api.yaml --output ./index.html'
- name: redoc-cli-github-action
uses: seeebiii/redoc-cli-github-action@v10
with:
args: 'build-docs ./api.yaml --output ./index.html'

- name: check result
run: |
ls -al
test -f index.html || (echo "Missing index.html from previous step." && exit 1)
# 웹페이지 Repository에 Push 합니다.
- name: Install SSH Key
uses: leigholiver/[email protected]
Expand Down

0 comments on commit c660b92

Please sign in to comment.