Files
2025-03-17 13:55:33 +08:00

84 lines
2.2 KiB
JSON

{
"openapi": "3.0.0",
"info": {
"title": "SearXNG Search",
"version": "1.0.0"
},
"servers": [
{
"url": "https://YOUR_SEARXNG_INSTANCE_URL",
"description": "SearXNG instance URL."
}
],
"paths": {
"/search": {
"get": {
"summary": "Perform a search query (GET)",
"operationId": "SearXNGSearch",
"parameters": [
{
"name": "q",
"in": "query",
"description": "The search query string.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "category",
"in": "query",
"description": "Category of the search. Defaults to 'general'.",
"schema": {
"type": "string",
"enum": ["general", "news"],
"default": "general"
}
},
{
"name": "format",
"in": "query",
"description": "Output format of the results. Defaults to 'json'.",
"required": true,
"schema": {
"type": "string",
"default": "json"
}
}
],
"responses": {
"200": {
"description": "Search results retrieved successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": { "type": "string" },
"link": { "type": "string" },
"snippet": { "type": "string" }
},
"required": ["title", "link"]
}
},
"total": { "type": "integer" }
},
"required": ["results"]
}
}
}
},
"400": {
"description": "Invalid request parameters."
}
}
}
}
}
}