Feat/add GitHub workflow for api docs

.github/workflows/publish-api-docs.yml

@@ -0,0 +1,45 @@
+name: Publish Api Docs to GitHub Pages
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  publish-api-docs:
+    runs-on: ubuntu-latest
+
+    services:
+      mysql:
+        image: mysql:8.0.39
+        env:
+          MYSQL_ROOT_PASSWORD: userfeedback
+          MYSQL_DATABASE: userfeedback
+          MYSQL_USER: userfeedback
+          MYSQL_PASSWORD: userfeedback
+          TZ: UTC
+        ports:
+          - 13306:3306
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Build app and swagger docs
+        run: |
+          npx corepack enable
+          pnpm install --frozen-lockfile
+          pnpm build
+          cd apps/api
+          cp .env.example .env
+          npx ts-node -r tsconfig-paths/register src/scripts/build-swagger-docs.ts
+
+      - name: Run Redocly CLI
+        uses: fluximus-prime/redocly-cli-github-action@v1
+        with:
+          args: "build-docs apps/api/swagger.json --output docs/index.html"
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs

GUIDE.md

@@ -1,4 +1,4 @@
-# ABC User Feedback Guide
+# ABC User Feedback Integration Guide
 
 ## Image Storage Integration
 
@@ -8,13 +8,13 @@ ABC User Feedback supports the integration of image storage solutions to handle
 
 There are two methods for uploading images associated with feedback:
 
-1. **Multipart Upload API**: This method requires setting up the [image configuration](#configuration). Once configured, you can use the multipart upload API to securely upload images directly to your storage service.
+1. **Multipart Upload API**: This method requires setting up the [image configuration](#S3-configuration). Once configured, you can use the multipart upload API to securely upload images directly to your storage service.
 
 2. **Feedback Creation API with Image URLs**: Alternatively, users can submit feedback with image URLs. This method does not require the image configuration setup; however, the image URLs must come from the whitelisted domains.
 
 **Note**: For detailed instructions on using these methods, please refer to the API documentation. You can see the documentation by accessing to `{API server host}/docs` or `{API server host}/docs/redoc`.
 
-### Configuration
+### S3 Configuration
 
 To enable image uploads directly to the server, you must configure the image storage settings. The service uses the following configuration parameters and you can set them in the setting menu.
 

README.md

@@ -6,6 +6,17 @@ ABC User Feedback is a standalone web application that manages Voice of Customer
 
 ![sample image](./assets/main.png)
 
+## Table of Contents
+
+- [Features](#Features)
+- [Getting Started](#Getting-Started)
+- [Configuration](#configuration)
+- [Integration](#Integration)
+- [Development](#Development)
+- [Contributing](#Contributing-Guidelines)
+- [License](#license)
+
+
 ## Features
 
 ABC User Feedback provides the following features:
@@ -56,21 +67,31 @@ docker pull line/abc-user-feedback-web
 docker pull line/abc-user-feedback-api
 ```
 
-### Configuration
+## Configuration
 
-**Frontend**
+### Frontend
 
 :point_right: [Go to Frontend README](./apps/web/README.md)
 
 You can configure the frontend for session password, maximum time span to query, etc.
 
-**Backend**
+### Backend
 
 :point_right: [Go to Backend README](./apps/api/README.md)
 
 You can configure the backend for MySQL, SMTP for email verification, OpenSearch-powered improved search experience, etc.
 
-## Setup Dev Environment using Command Line Tool without Dependencies
+## Integration
+
+If you want to integrate ABC User Feedback with your service, you can use the following features:
+
+1. RESTful Web API - [API document page](https://line.github.io/abc-user-feedback).
+1. Accept images from user - [S3 Integration](./GUIDE.md#image-storage-integration).
+1. Webhooks - [Webhook specification](./GUIDE.md#Webhook-Feature).
+
+## Development
+
+### Setup Dev Environment using Command Line Tool without Dependencies
 
 ABC User Feedback supports a command line tool(`auf-cli`) that easily runs both the frontend and backend.
 
@@ -84,7 +105,7 @@ npx auf-cli stop # stop app
 
 Please refer to the following npm package site: https://www.npmjs.com/package/auf-cli
 
-## Setup Dev Environment Manually (Local)
+### Setup Dev Environment Manually (Local)
 
 ABC User Feedback is using a monorepo (powered by [TurboRepo](https://turbo.build/)) with multiple apps and packages.
 
@@ -129,10 +150,6 @@ pnpm turbo run dev --filter=web
 pnpm turbo run dev --filter=api
 ```
 
-### ADMIN WEB GUIDE
-
-For detailed information on using the admin web interface, please refer to our [Admin Web Guide](./GUIDE.md).
-
 ### Build Docker Image
 
 For your code build, you can build docker image using docker-compose. Please refer to [remote caching](https://turbo.build/repo/docs/core-concepts/remote-caching) and [deploying with docker](https://turbo.build/repo/docs/handbook/deploying-with-docker) using `turborepo`.

apps/api/src/scripts/build-swagger-docs.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+import { writeFileSync } from 'fs';
+import { NestFactory } from '@nestjs/core';
+import type { NestFastifyApplication } from '@nestjs/platform-fastify';
+import { FastifyAdapter } from '@nestjs/platform-fastify';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { initializeTransactionalContext } from 'typeorm-transactional';
+
+import { AppModule } from '../app.module';
+import { APIModule } from '../domains/api/api.module';
+
+async function generateSwaggerDoc() {
+  initializeTransactionalContext();
+  const app = await NestFactory.create<NestFastifyApplication>(
+    AppModule,
+    new FastifyAdapter({}),
+    { bufferLogs: true },
+  );
+
+  const documentConfig = new DocumentBuilder()
+    .setTitle('User Feedback API Document')
+    .setDescription(
+      `You can use this API to integrate with your own service or system. This API is protected by a simple API key authentication, so please do not expose this API to the public. You can make an API key in the admin setting page. You should put the API key in the header with the key name 'x-api-key'.
+      `,
+    )
+    .setVersion('1.0.0')
+    .addApiKey({ type: 'apiKey', name: 'x-api-key', in: 'header' }, 'apiKey')
+    .build();
+  const document = SwaggerModule.createDocument(app, documentConfig, {
+    include: [APIModule],
+  });
+  writeFileSync('./swagger.json', JSON.stringify(document));
+  await app.close();
+}
+
+void generateSwaggerDoc();

renovate.json

@@ -3,7 +3,8 @@
   "extends": ["config:recommended"],
   "ignorePaths": [
     "**/.github/workflows/e2e-test.yml",
-    "**/.github/workflows/integration-test.yml"
+    "**/.github/workflows/integration-test.yml",
+    "**/.github/workflows/publish-api-docs.yml"
   ],
   "baseBranches": ["dev"],
   "packageRules": [