Skip to content

Commit 6af92f2

Browse files
committed
[#73] Add /docs endpoint
1 parent add18a2 commit 6af92f2

File tree

7 files changed

+10
-15
lines changed

7 files changed

+10
-15
lines changed

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Always run tests inside the Docker container via the provided shell scripts.
179179

180180
After starting services:
181181
- **Frontend**: http://127.0.0.1.nip.io
182-
- **API Docs**: http://127.0.0.1.nip.io/redoc
182+
- **API Docs**: http://127.0.0.1.nip.io/docs
183183
- **Health Check**: http://127.0.0.1.nip.io/api/health
184184
- **RAG Evaluation Dashboard**: http://localhost:8501 (when `./rag-evaluate` is running)
185185
- **App Registration API**: http://localhost:8000/v1/apps/* (see `backend/docs/APP_REGISTRATION.md`)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ docker compose up -d --build
228228
Access the following URLs after service startup:
229229

230230
- 🌐 Frontend UI: http://127.0.0.1.nip.io
231-
- 📚 API Documentation: http://127.0.0.1.nip.io/redoc
231+
- 📚 API Documentation: http://127.0.0.1.nip.io/docs
232232

233233
## 🔌 MCP Server Setup (Required)
234234

README.zh-CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ docker compose up -d --build
211211
服务启动后,可以通过以下地址访问:
212212

213213
- 🌐 前端界面: http://127.0.0.1.nip.io
214-
- 📚 API 文档: http://127.0.0.1.nip.io/redoc
214+
- 📚 API 文档: http://127.0.0.1.nip.io/docs
215215

216216
## 🏗️ 技术架构
217217

docs/blog/deploy-local.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ docker compose up -d --build
9696
服务启动后,可以通过以下地址访问:
9797

9898
- 前端界面:<http://localhost:3000>
99-
- API 文档:<http://localhost:8000/redoc>
99+
- API 文档:<http://localhost:8000/docs>
100100

101101
## 📚 使用指南
102102

nginx.conf

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ http {
6363
proxy_cache_bypass $http_upgrade;
6464
}
6565

66-
# API Documentation (Redoc)
67-
location /redoc {
68-
proxy_pass http://backend/redoc;
66+
# API Documentation
67+
location /docs {
68+
proxy_pass http://backend/docs;
6969
proxy_set_header Host $host;
7070
proxy_set_header X-Real-IP $remote_addr;
7171
}

nginx.dev.conf

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,6 @@ http {
114114
proxy_set_header X-Real-IP $remote_addr;
115115
}
116116

117-
location /redoc {
118-
proxy_pass http://backend/redoc;
119-
proxy_set_header Host $host;
120-
proxy_set_header X-Real-IP $remote_addr;
121-
}
122117

123118
location /openapi.json {
124119
proxy_pass http://backend/openapi.json;

nginx/nginx.conf

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,9 @@ http {
8686
proxy_cache_bypass $http_upgrade;
8787
}
8888

89-
# API Documentation (Redoc)
90-
location /redoc {
91-
proxy_pass http://backend/redoc;
89+
# API Documentation
90+
location /docs {
91+
proxy_pass http://backend/docs;
9292
proxy_set_header Host $host;
9393
proxy_set_header X-Real-IP $remote_addr;
9494
}

0 commit comments

Comments
 (0)