docs: add open api (#360)

* chore(api): add comment for open api Signed-off-by: qwqcode <[email protected]> * docs: add open api generation support Signed-off-by: qwqcode <[email protected]> --------- Signed-off-by: qwqcode <[email protected]>
ArtalkJS · Jan 28, 2023 · 9a680f0 · 9a680f0
1 parent ee6bcd8
commit 9a680f0
Show file tree

Hide file tree

Showing 54 changed files with 11,318 additions and 720 deletions.
diff --git a/.gitignore b/.gitignore
@@ -53,10 +53,6 @@ yarn-error.log*
 node_modules
 /ui/**/dist
 
-# docs
-/docs/.vitepress/dist/
-/docs/.vitepress/cache/
-
 # backend
 /artalk.yml
 /config.yml

diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -4,11 +4,11 @@
         {
             "label": "Build for debugging",
             "type": "shell",
-            "command": "make debug-build",
+            "command": "make build-debug",
             "group": {
                 "kind": "build",
                 "isDefault": true
             }
         }
     ]
-}
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -34,7 +34,7 @@ cd Artalk
 First, we need to install the dependencies for backend written in Go. Simply run the following command:
 
 ```sh
-make debug-build
+make build-debug
 ```
 
 This will build both the frontend and backend, with debugging symbols.

diff --git a/Makefile b/Makefile
@@ -47,6 +47,9 @@ test-coverage:
 update-i18n:
 	go generate ./internal/i18n
 
+update-swagger:
+	swag init -g server/server.go --output ./docs/swagger
+
 docker-build:
 	./scripts/docker-build.sh
 

diff --git a/README.en.md b/README.en.md
@@ -70,7 +70,7 @@ new Artalk({
   pageTitle: 'The title of your page',    // Page Title
   server:    'http://localhost:8080/api', // Server URL
   site:      'Site Name',
-  i18n:      'en-US'
+  locale:    'en'
 })
 ```
 
@@ -109,6 +109,10 @@ services:
 docker-compose up -d
 ```
 
+## Development
+
+see [CONTRIBUTING.md](./CONTRIBUTING.md)
+
 ## Contributors
 
 [![](https://contrib.rocks/image?repo=ArtalkJS/Artalk)](https://github.com/ArtalkJS/Artalk/graphs/contributors)

diff --git a/README.md b/README.md
@@ -96,6 +96,10 @@ services:
 docker-compose up -d
 ```
 
+## Development
+
+see [CONTRIBUTING.md](./CONTRIBUTING.md)
+
 ## Contributors
 
 [![](https://contrib.rocks/image?repo=ArtalkJS/Artalk)](https://github.com/ArtalkJS/Artalk/graphs/contributors)

diff --git a/conf/artalk.example.yml b/conf/artalk.example.yml
@@ -4,7 +4,7 @@ host: "0.0.0.0"
 # Listen port
 port: 23366
 
-# App Key (for generation of JWT token)
+# App Key (for generation of JWT)
 app_key: ""
 
 # Debug mode

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,3 @@
+/.vitepress/dist/
+/.vitepress/cache/
+/public/http-api.html