This commit is contained in:
V-LiuShuang
2026-08-13 15:47:05 +08:00
parent 951799c3de
commit f4311b63a0
3 changed files with 73 additions and 2 deletions
+5 -2
View File
@@ -9,7 +9,10 @@ description: 在`mis-agent`模块编写代码必备技能。
- [核心技术栈](./references/arch.md) - [核心技术栈](./references/arch.md)
- [代码书写规范](./references/coding-rules.md) - [代码书写规范](./references/coding-rules.md)
- [HTTP接口文档示例](./examples/api-doc.md) - [HTTP接口文档示例](./examples/api-doc.md)
- [如何从nacos读取配置项](./references/nacos.md)
## 核心约束 ## 约定
请结合**目录结构**与**核心技术栈**,并严格遵守**代码书写规范**修改、编写代码,被要求编写HTTP接口文档时,请参考**HTTP接口文档示例**。 - 请结合**目录结构**与**核心技术栈**,并严格遵守**代码书写规范**修改、编写代码,被要求编写HTTP接口文档时,请参考**HTTP接口文档示例**。
- 当前项目具有3个环境(dev/qas/prod)若没有指定**环境**则默认使用**qas**,不可以访问**prod**环境任何数据,包括但不限于数据库、HTTP接口。
- 从**根目录**下的**pom.xml**文件`<profiles>`标签里可得到不同环境下的`nacos`以及`NewAPI`连接信息。
@@ -1,5 +1,18 @@
# 目录结构 # 目录结构
## 根目录
```text
\
├── mis-api\
├── mis-auth\
├── mis-common\
├── mis-gateway\
├── mis-modules\ # 存放业务模块代码的主目录
├── mis-visual\
└── pom.xml # 在<profiles>中定义了Nacos地址及账号密码、NewAPI的地址和密钥
```
## 主目录 ## 主目录
```text ```text
+55
View File
@@ -0,0 +1,55 @@
# Intro
你可以通过本文档获取访问Nacos配置文件的方法。下文中的`{base_url}``{username}``password`需要从**pom.xml**的**profiles**标签中获取。根据**配置文件说明**以及上下文决定使用哪个`{dataId}`,没有特殊要求`{groupName}`使用`DEFAULT_GROUP`即可。对于`{namespace}`需要结合上下文确定当前的环境,默认是`qas`
## 配置文件说明
| dataId |分组| namespaceId |描述 |
|---|---|---|---|
|`mis-agent.yml`|DEFAULT_GROUP|dev/qas|当前模块也就是**mis-agent**应用的配置文件|
|`datasource.yml`|DEFAULT_GROUP|dev/qas|`MySQL`数据源配置|
## 如何获取accessToken
请求示例:
```bash
curl -X POST 'http://{base_url}/nacos/v1/auth/login' -d 'username={username}&password={password}'
```
输出示例:
```json
{"accessToken":"xxx","tokenTtl":18000,"globalAdmin":true}
```
## 如何获取配置项
1. 参考**如何获取accessToken**获取**accessToken**。
2. 携带**accessToken**获取配置项。
请求示例:
```bash
curl -X GET "http://{base_url}/nacos/v3/console/cs/config?dataId={dataId}&groupName={groupName}&namespaceId={namespace}" -H "Authorization: Bearer xxx"
```
输出示例如下,`data.content`就是**yml**格式的配置内容。
```json
{
"code": 0,
"message": "success",
"data": {
"resultCode": 200,
"errorCode": 0,
"message": null,
"requestId": null,
"content": "...",
"encryptedDataKey": "",
"contentType": "yaml",
"md5": "7eccfe8d4aa1df087520d7678419fbbd",
"lastModified": 1786090433000,
"tag": null,
"beta": false,
"success": true
}
}
```