feat: add vitepress-openapi dependency and create OpenAPI documentation

- Added vitepress-openapi as a dependency in package.json.
- Updated pnpm-lock.yaml to include vitepress-openapi and its dependencies.
- Created a new scalar.html file for the AstrBot OpenAPI interface.
- Added Chinese documentation for the AstrBot HTTP API, detailing usage, scopes, and examples.

Author: Soulter

.vitepress/config.mjs

@@ -28,6 +28,7 @@ export default defineConfig({
           { text: "开始", link: "/what-is-astrbot" },
           { text: "博客", link: "https://blog.astrbot.app" },
           { text: "路线图", link: "https://astrbot.featurebase.app/roadmap" },
+          { text: "HTTP API", link: "https://docs.astrbot.app/scalar.html" },
         ],
         sidebar: [
           {
@@ -204,6 +205,10 @@ export default defineConfig({
                 text: "接入平台适配器",
                 link: "/plugin-platform-adapter",
               },
+              {
+                text: "AstrBot HTTP API",
+                link: "/openapi",
+              },
             ],
           },
           {
@@ -256,6 +261,7 @@ export default defineConfig({
         nav: [
           { text: "Home", link: "/en/" },
           { text: "Get Started", link: "/en/what-is-astrbot" },
+          { text: "HTTP API", link: "https://docs.astrbot.app/scalar.html" },
         ],
         sidebar: [
           {
@@ -425,6 +431,10 @@ export default defineConfig({
                 text: "Platform Adapter Integration",
                 link: "/plugin-platform-adapter",
               },
+              {
+                text: "AstrBot HTTP API",
+                link: "/openapi",
+              },
             ],
           },
           {

.vitepress/theme/index.js

@@ -1,20 +1,30 @@
 // https://vitepress.dev/guide/custom-theme
 import { h } from 'vue'
 import DefaultTheme from 'vitepress/theme'
+import { theme as openapiTheme, useOpenapi } from 'vitepress-openapi/client'
+import 'vitepress-openapi/dist/style.css'
+import openapiSpec from '../../public/openapi.json'
 import './styles/style.css'
 import './styles/custom-block.css'
 import './styles/font.css'
-import ArticleShare from "./components/ArticleShare.vue";
+import ArticleShare from './components/ArticleShare.vue'
 import NotFound from './components/NotFound.vue'
 
 /** @type {import('vitepress').Theme} */
 export default {
   extends: DefaultTheme,
+  enhanceApp(ctx) {
+    openapiTheme.enhanceApp(ctx)
+    useOpenapi({
+      app: ctx.app,
+      spec: openapiSpec
+    })
+  },
   Layout() {
     return h(DefaultTheme.Layout, null, {
       // https://vitepress.dev/guide/extending-default-theme#layout-slots
-      "aside-outline-after": () => h(ArticleShare),
-      "not-found": () => h(NotFound),
+      'aside-outline-after': () => h(ArticleShare),
+      'not-found': () => h(NotFound)
     })
   }
 }

en/dev/openapi.md

@@ -0,0 +1,51 @@
+---
+outline: deep
+---
+
+# AstrBot HTTP API
+
+Starting from v4.18.0, AstrBot provides API Key based HTTP APIs for programmatic access.
+
+## Quick Start
+
+1. Create an API key in WebUI.
+2. Include the API key in request headers:
+
+```http
+Authorization: Bearer abk_xxx
+```
+
+Also supported:
+
+```http
+X-API-Key: abk_xxx
+```
+
+3. For chat endpoints, `username` is required:
+
+- `POST /api/v1/chat`: request body must include `username`
+- `GET /api/v1/chat/sessions`: query params must include `username`
+
+## Common Endpoints
+
+- `POST /api/v1/chat`: send chat message (SSE stream, server generates UUID when `session_id` is omitted)
+- `GET /api/v1/chat/sessions`: list sessions for a specific `username` with pagination
+- `GET /api/v1/configs`: list available config files
+- `POST /api/v1/file`: upload attachment
+- `POST /api/v1/im/message`: proactive message via UMO
+- `GET /api/v1/im/bots`: list bot/platform IDs
+
+## Example
+
+```bash
+curl -N 'http://localhost:6185/api/v1/chat' \
+  -H 'Authorization: Bearer abk_xxx' \
+  -H 'Content-Type: application/json' \
+  -d '{"message":"Hello","username":"alice"}'
+```
+
+## Full API Reference
+
+Use the interactive docs:
+
+- https://docs.astrbot.app/scalar.html