Redoc API 문서 생성 (#12)

GitHub Actions를 이용해 Redoc API 문서를 만들고 웹으로 배포.

각 프로젝트의 `README.md` 파일에 배포된 Redoc 문서 URL 추가.

References:
- https://github.com/Redocly/redoc
- https://redocly.com/redoc

Author: ahastudio

.github/workflows/build-and-deploy.yml

@@ -13,23 +13,33 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       contents: write
-    if: github.ref == 'refs/heads/main'
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+      - name: Install Redocly CLI
+        run: npm install -g @redocly/cli@latest
       - name: Generate Swagger UI for Todo App
         uses: Legion2/swagger-ui-action@v1
         with:
           output: public/todo-app
           spec-file: ./todo-app/openapi.yaml
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Generate Redoc API document for Todo App
+        run: |
+          redocly build-docs ./todo-app/openapi.yaml -o public/todo-app/redoc.html
       - name: Generate Swagger UI for Tickets API
         uses: Legion2/swagger-ui-action@v1
         with:
           output: public/tickets
           spec-file: ./tickets/openapi.yaml
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Generate Redoc API document for Tickets API
+        run: |
+          redocly build-docs ./tickets/openapi.yaml -o public/tickets/redoc.html
       - name: Deploy to GitHub Pages
+        if: github.ref == 'refs/heads/main'
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+public/

tickets/README.md

@@ -2,3 +2,6 @@
 
 Swagger UI:
 <https://dal-lab.github.io/openapi-sample/tickets>
+
+Redoc:
+<https://dal-lab.github.io/openapi-sample/tickets/redoc.html>

todo-app/README.md

@@ -2,3 +2,6 @@
 
 Swagger UI:
 <https://dal-lab.github.io/openapi-sample/todo-app>
+
+Redoc:
+<https://dal-lab.github.io/openapi-sample/todo-app/redoc.html>