mirror of
https://github.com/CherryHQ/cherry-studio.git
synced 2025-12-25 11:20:07 +08:00
c785be82dd
- Rename SessionLogEntity → SessionMessageEntity type definition - Rename SessionLogService → SessionMessageService with all methods - Rename API routes /logs → /messages for better REST semantics - Update database queries and service layer naming - Update all Swagger documentation and validation middleware - Maintain backward compatibility in database schema This improves code readability by using more accurate terminology for conversational message data rather than generic "log" naming.
138 lines
3.6 KiB
TypeScript
138 lines
3.6 KiB
TypeScript
import { loggerService } from '@main/services/LoggerService'
|
|
import cors from 'cors'
|
|
import express from 'express'
|
|
import { v4 as uuidv4 } from 'uuid'
|
|
|
|
import { authMiddleware } from './middleware/auth'
|
|
import { errorHandler } from './middleware/error'
|
|
import { setupOpenAPIDocumentation } from './middleware/openapi'
|
|
import { agentsRoutes } from './routes/agents'
|
|
import { chatRoutes } from './routes/chat'
|
|
import { mcpRoutes } from './routes/mcp'
|
|
import { modelsRoutes } from './routes/models'
|
|
import { sessionMessagesRoutes } from './routes/session-messages'
|
|
import { sessionsRoutes } from './routes/sessions'
|
|
|
|
const logger = loggerService.withContext('ApiServer')
|
|
|
|
const app = express()
|
|
|
|
// Global middleware
|
|
app.use((req, res, next) => {
|
|
const start = Date.now()
|
|
res.on('finish', () => {
|
|
const duration = Date.now() - start
|
|
logger.info(`${req.method} ${req.path} - ${res.statusCode} - ${duration}ms`)
|
|
})
|
|
next()
|
|
})
|
|
|
|
app.use((_req, res, next) => {
|
|
res.setHeader('X-Request-ID', uuidv4())
|
|
next()
|
|
})
|
|
|
|
app.use(
|
|
cors({
|
|
origin: '*',
|
|
allowedHeaders: ['Content-Type', 'Authorization'],
|
|
methods: ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS']
|
|
})
|
|
)
|
|
|
|
/**
|
|
* @swagger
|
|
* /health:
|
|
* get:
|
|
* summary: Health check endpoint
|
|
* description: Check server status (no authentication required)
|
|
* tags: [Health]
|
|
* security: []
|
|
* responses:
|
|
* 200:
|
|
* description: Server is healthy
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* properties:
|
|
* status:
|
|
* type: string
|
|
* example: ok
|
|
* timestamp:
|
|
* type: string
|
|
* format: date-time
|
|
* version:
|
|
* type: string
|
|
* example: 1.0.0
|
|
*/
|
|
app.get('/health', (_req, res) => {
|
|
res.json({
|
|
status: 'ok',
|
|
timestamp: new Date().toISOString(),
|
|
version: process.env.npm_package_version || '1.0.0'
|
|
})
|
|
})
|
|
|
|
/**
|
|
* @swagger
|
|
* /:
|
|
* get:
|
|
* summary: API information
|
|
* description: Get basic API information and available endpoints
|
|
* tags: [General]
|
|
* security: []
|
|
* responses:
|
|
* 200:
|
|
* description: API information
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* properties:
|
|
* name:
|
|
* type: string
|
|
* example: Cherry Studio API
|
|
* version:
|
|
* type: string
|
|
* example: 1.0.0
|
|
* endpoints:
|
|
* type: object
|
|
*/
|
|
app.get('/', (_req, res) => {
|
|
res.json({
|
|
name: 'Cherry Studio API',
|
|
version: '1.0.0',
|
|
endpoints: {
|
|
health: 'GET /health',
|
|
models: 'GET /v1/models',
|
|
chat: 'POST /v1/chat/completions',
|
|
mcp: 'GET /v1/mcps',
|
|
agents: 'GET /v1/agents',
|
|
sessions: 'GET /v1/sessions',
|
|
logs: 'GET /v1/sessions/{sessionId}/logs'
|
|
}
|
|
})
|
|
})
|
|
|
|
// API v1 routes with auth
|
|
const apiRouter = express.Router()
|
|
apiRouter.use(authMiddleware)
|
|
apiRouter.use(express.json())
|
|
// Mount routes
|
|
apiRouter.use('/chat', chatRoutes)
|
|
apiRouter.use('/mcps', mcpRoutes)
|
|
apiRouter.use('/models', modelsRoutes)
|
|
apiRouter.use('/agents', agentsRoutes)
|
|
apiRouter.use('/sessions', sessionsRoutes)
|
|
apiRouter.use('/', sessionMessagesRoutes) // This handles /sessions/:sessionId/messages and /session-messages/:messageId
|
|
app.use('/v1', apiRouter)
|
|
|
|
// Setup OpenAPI documentation
|
|
setupOpenAPIDocumentation(app)
|
|
|
|
// Error handling (must be last)
|
|
app.use(errorHandler)
|
|
|
|
export { app }
|