Update openapi.yaml
Improve: Allow custom protocol, server, and port configuration - Add protocol selector (http/https) - Allow custom port input (not just predefined) - Single unified server configuration - Better flexibility for users with custom setups
This commit is contained in:
+21
-19
@@ -17,15 +17,23 @@ info:
|
|||||||
### 🔗 Base URL Pattern
|
### 🔗 Base URL Pattern
|
||||||
|
|
||||||
```
|
```
|
||||||
http://YOUR_SERVER/<Access-Code>/?api_key=<API-KEY>&action=ACTION
|
{protocol}://YOUR_SERVER:{port}/<Access-Code>/?api_key=<API-KEY>&action=ACTION
|
||||||
```
|
```
|
||||||
|
|
||||||
**Replace:**
|
**Customize:**
|
||||||
- `YOUR_SERVER` → Your server domain/IP
|
- `{protocol}` → http or https
|
||||||
|
- `YOUR_SERVER` → Your server domain/IP (e.g., 192.168.1.100)
|
||||||
|
- `{port}` → Your port (80, 8000, 9000, or custom)
|
||||||
- `<Access-Code>` → Your access code (e.g., `cSbuFLhp`)
|
- `<Access-Code>` → Your access code (e.g., `cSbuFLhp`)
|
||||||
- `<API-KEY>` → Your API key
|
- `<API-KEY>` → Your API key
|
||||||
- `ACTION` → API action name (e.g., `get_lines`)
|
- `ACTION` → API action name (e.g., `get_lines`)
|
||||||
|
|
||||||
|
**Common Ports:**
|
||||||
|
- `80` - HTTP (default)
|
||||||
|
- `8000` - HTTP (alternative)
|
||||||
|
- `9000` - HTTPS (recommended)
|
||||||
|
- Custom - Any port you configured
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 🔐 Authentication Setup
|
### 🔐 Authentication Setup
|
||||||
@@ -104,27 +112,21 @@ info:
|
|||||||
url: https://xui.one
|
url: https://xui.one
|
||||||
|
|
||||||
servers:
|
servers:
|
||||||
- url: http://{server}:{port}/{accessCode}
|
- url: '{protocol}://{server}:{port}/{accessCode}'
|
||||||
description: XUI.ONE API Server (HTTP)
|
description: XUI.ONE API Server (Customizable)
|
||||||
variables:
|
variables:
|
||||||
|
protocol:
|
||||||
|
default: http
|
||||||
|
description: Protocol (http or https)
|
||||||
|
enum:
|
||||||
|
- http
|
||||||
|
- https
|
||||||
server:
|
server:
|
||||||
default: your-server.com
|
default: your-server.com
|
||||||
description: Your XUI.ONE server IP or domain
|
description: Your XUI.ONE server IP or domain (e.g., 192.168.1.100 or panel.yourdomain.com)
|
||||||
port:
|
port:
|
||||||
default: '80'
|
default: '80'
|
||||||
description: API port
|
description: API port (80 for HTTP, 9000 for HTTPS, or custom port)
|
||||||
enum:
|
|
||||||
- '80'
|
|
||||||
- '8000'
|
|
||||||
accessCode:
|
|
||||||
default: cSbuFLhp
|
|
||||||
description: Your unique access code for API access
|
|
||||||
- url: https://{server}:9000/{accessCode}
|
|
||||||
description: XUI.ONE API Server (HTTPS - Recommended)
|
|
||||||
variables:
|
|
||||||
server:
|
|
||||||
default: your-server.com
|
|
||||||
description: Your XUI.ONE server IP or domain
|
|
||||||
accessCode:
|
accessCode:
|
||||||
default: cSbuFLhp
|
default: cSbuFLhp
|
||||||
description: Your unique access code for API access
|
description: Your unique access code for API access
|
||||||
|
|||||||
Reference in New Issue
Block a user