From d08885c209c1199354d1bd4e58b8f8cc33b10bcc Mon Sep 17 00:00:00 2001
From: click33 <2393584716@qq.com>
Date: Tue, 8 Apr 2025 02:23:02 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=96=B0=E5=A2=9E=20apikey=20=E6=8F=90?=
=?UTF-8?q?=E4=BA=A4=E6=96=B9=E5=BC=8F=E6=8F=8F=E8=BF=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
sa-token-demo/sa-token-demo-async/pom.xml | 71 -----------------------
sa-token-doc/plugin/api-key.md | 24 +++++++-
2 files changed, 23 insertions(+), 72 deletions(-)
diff --git a/sa-token-demo/sa-token-demo-async/pom.xml b/sa-token-demo/sa-token-demo-async/pom.xml
index 4f512b56..1f63a9e7 100644
--- a/sa-token-demo/sa-token-demo-async/pom.xml
+++ b/sa-token-demo/sa-token-demo-async/pom.xml
@@ -41,19 +41,6 @@
${sa-token.version}
-
- cn.hutool
- hutool-all
- 5.8.36
-
-
-
-
-
cn.dev33
@@ -73,65 +60,7 @@
spring-boot-configuration-processor
true
-
- org.springframework.boot
- spring-boot-starter-actuator
-
-
-
-
-
-
- src/main/java
-
- **/*.xml
-
-
-
- src/main/resources
-
- **/*.*
-
-
-
-
-
-
- org.apache.maven.plugins
- maven-jar-plugin
-
-
-
- true
- lib/
- ${java.run.main.class}
-
-
-
-
-
-
- org.apache.maven.plugins
- maven-dependency-plugin
-
-
- copy
- package
-
- copy-dependencies
-
-
-
- ${project.build.directory}/lib
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/sa-token-doc/plugin/api-key.md b/sa-token-doc/plugin/api-key.md
index 37e6f0e3..1531ab4f 100644
--- a/sa-token-doc/plugin/api-key.md
+++ b/sa-token-doc/plugin/api-key.md
@@ -177,7 +177,29 @@ public class ApiKeyResourcesController {
```
-### 4、打开数据库模式
+### 4、前端如何提交 API Key?
+默认情况下,前端可以从任意途径提交 API Key 字符串,只要后端能接受到。
+
+但是如果后端是通过 `SaApiKeyUtil.currentApiKey()` 方法获取,或者 `@SaCheckApiKey` 注解校验,则需要前端按照一定的格式来提交了:
+
+方式一:通过请求参数或请求头,参数名为 `apikey`(全小写)
+
+``` url
+/user/getInfo?apikey=AK-NAO6u57zbOWCmLaiVQuVW2tyt3rHpZrXkaQp
+```
+
+
+方式二:通过 Basic 参数提交
+
+``` url
+http://AK-NAO6u57zbOWCmLaiVQuVW2tyt3rHpZrXkaQp@localhost:8081/user/getInfo
+```
+
+
+
+
+
+### 5、打开数据库模式
框架默认将所有 API Key 信息保存在缓存中,这可以称之为“缓存模式”,这种模式下,重启缓存库后,数据将丢失。