File size: 11,771 Bytes
15f7aec |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
const openApiSpec = {
openapi: "3.0.3",
info: {
title: "CF Bypass Solver API",
description: "API for solving Cloudflare challenges including Turnstile captchas, WAF sessions, and proxy requests.",
version: "1.0.0"
},
servers: [
{
url: "/",
description: "Current server"
}
],
paths: {
"/solver": {
get: {
summary: "Solver endpoint (GET)",
description: "Handle solver requests via GET method. The mode parameter determines which solver to use.",
parameters: [
{ $ref: "#/components/parameters/mode" },
{ $ref: "#/components/parameters/url" },
{ $ref: "#/components/parameters/authToken" },
{ $ref: "#/components/parameters/siteKey" }
],
responses: {
200: { $ref: "#/components/responses/SuccessResponse" },
400: { $ref: "#/components/responses/BadRequest" },
401: { $ref: "#/components/responses/Unauthorized" },
429: { $ref: "#/components/responses/TooManyRequests" },
500: { $ref: "#/components/responses/ServerError" }
}
},
post: {
summary: "Solver endpoint (POST)",
description: "Handle solver requests via POST method. The mode parameter determines which solver to use.",
requestBody: {
required: true,
content: {
"application/json": {
schema: { $ref: "#/components/schemas/SolverRequest" }
}
}
},
responses: {
200: { $ref: "#/components/responses/SuccessResponse" },
400: { $ref: "#/components/responses/BadRequest" },
401: { $ref: "#/components/responses/Unauthorized" },
429: { $ref: "#/components/responses/TooManyRequests" },
500: { $ref: "#/components/responses/ServerError" }
}
}
},
"/api-docs": {
get: {
summary: "OpenAPI Documentation UI",
description: "Interactive Swagger UI documentation for the API.",
responses: {
200: {
description: "HTML page with Swagger UI"
}
}
}
},
"/api-docs.json": {
get: {
summary: "OpenAPI JSON Specification",
description: "Returns the raw OpenAPI specification in JSON format.",
responses: {
200: {
description: "OpenAPI specification",
content: {
"application/json": {
schema: {
type: "object"
}
}
}
}
}
}
}
},
components: {
parameters: {
mode: {
name: "mode",
in: "query",
required: true,
description: "The solver mode to use",
schema: {
type: "string",
enum: ["source", "turnstile-min", "turnstile-max", "waf-session", "proxy-request"]
}
},
url: {
name: "url",
in: "query",
required: true,
description: "Target URL to process",
schema: {
type: "string",
format: "uri"
}
},
authToken: {
name: "authToken",
in: "query",
required: false,
description: "Authentication token (required if server has authToken configured)",
schema: {
type: "string"
}
},
siteKey: {
name: "siteKey",
in: "query",
required: false,
description: "Turnstile site key (required for turnstile modes)",
schema: {
type: "string"
}
}
},
schemas: {
SolverRequest: {
type: "object",
required: ["mode", "url"],
properties: {
mode: {
type: "string",
enum: ["source", "turnstile-min", "turnstile-max", "waf-session", "proxy-request"],
description: "The solver mode to use"
},
url: {
type: "string",
format: "uri",
description: "Target URL to process"
},
authToken: {
type: "string",
description: "Authentication token (required if server has authToken configured)"
},
siteKey: {
type: "string",
description: "Turnstile site key (required for turnstile modes)"
},
proxy: {
type: "object",
description: "Proxy configuration",
properties: {
host: { type: "string", description: "Proxy host" },
port: { type: "integer", description: "Proxy port" },
username: { type: "string", description: "Proxy username" },
password: { type: "string", description: "Proxy password" }
}
},
method: {
type: "string",
enum: ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"],
description: "HTTP method for proxy-request mode"
},
body: {
oneOf: [
{ type: "string" },
{ type: "object" }
],
description: "Request body for proxy-request mode"
},
headers: {
type: "object",
description: "Custom headers for the request"
},
cookies: {
type: "array",
description: "Cookies to set for the request",
items: {
type: "object",
required: ["name", "value"],
properties: {
name: { type: "string" },
value: { type: "string" },
domain: { type: "string" },
path: { type: "string" },
secure: { type: "boolean" },
httpOnly: { type: "boolean" },
sameSite: { type: "string" }
}
}
},
sessionHeaders: {
type: "object",
description: "Session headers for waf-session mode"
}
}
},
SourceResponse: {
type: "object",
properties: {
code: { type: "integer", example: 200 },
source: { type: "string", description: "Page source HTML" }
}
},
TurnstileResponse: {
type: "object",
properties: {
code: { type: "integer", example: 200 },
token: { type: "string", description: "Solved Turnstile token" }
}
},
WafSessionResponse: {
type: "object",
properties: {
code: { type: "integer", example: 200 },
cookies: { type: "array", items: { type: "object" } },
headers: { type: "object" }
}
},
ProxyRequestResponse: {
type: "object",
properties: {
code: { type: "integer", example: 200 },
status: { type: "integer" },
headers: { type: "object" },
body: { type: "string" }
}
},
ErrorResponse: {
type: "object",
properties: {
code: { type: "integer" },
message: { type: "string" }
}
}
},
responses: {
SuccessResponse: {
description: "Successful response. Content varies based on mode used.",
content: {
"application/json": {
schema: {
oneOf: [
{ $ref: "#/components/schemas/SourceResponse" },
{ $ref: "#/components/schemas/TurnstileResponse" },
{ $ref: "#/components/schemas/WafSessionResponse" },
{ $ref: "#/components/schemas/ProxyRequestResponse" }
]
}
}
}
},
BadRequest: {
description: "Invalid request parameters",
content: {
"application/json": {
schema: {
type: "object",
properties: {
code: { type: "integer", example: 400 },
message: { type: "string", example: "Bad Request" },
schema: { type: "array", items: { type: "object" } }
}
}
}
}
},
Unauthorized: {
description: "Invalid or missing authentication token",
content: {
"application/json": {
schema: { $ref: "#/components/schemas/ErrorResponse" },
example: { code: 401, message: "Unauthorized" }
}
}
},
TooManyRequests: {
description: "Browser limit reached",
content: {
"application/json": {
schema: { $ref: "#/components/schemas/ErrorResponse" },
example: { code: 429, message: "Too Many Requests" }
}
}
},
ServerError: {
description: "Internal server error",
content: {
"application/json": {
schema: { $ref: "#/components/schemas/ErrorResponse" },
example: { code: 500, message: "Error message" }
}
}
}
}
}
};
module.exports = openApiSpec;
|