search_endpoints
Find and filter API endpoints using keywords, regex patterns, tags, or HTTP methods to quickly locate specific operations within your FastAPI application documentation.
Instructions
高级搜索 API 接口,支持关键词、正则表达式、标签、方法等多种搜索方式
Input Schema
Name | Required | Description | Default |
---|---|---|---|
include_deprecated | No | 是否包含已废弃的接口 | |
keyword | No | 搜索关键词(支持模糊匹配,不区分大小写) | |
limit | No | 返回结果数量限制 | |
methods | No | 按 HTTP 方法过滤,支持多个方法 | |
regex | No | 正则表达式搜索(与 keyword 互斥) | |
search_in | No | 搜索范围 | all |
tags | No | 按标签过滤,支持多个标签(OR 关系) |
Input Schema (JSON Schema)
{
"properties": {
"include_deprecated": {
"default": false,
"description": "是否包含已废弃的接口",
"type": "boolean"
},
"keyword": {
"description": "搜索关键词(支持模糊匹配,不区分大小写)",
"type": "string"
},
"limit": {
"default": 50,
"description": "返回结果数量限制",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"methods": {
"description": "按 HTTP 方法过滤,支持多个方法",
"items": {
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"OPTIONS"
],
"type": "string"
},
"type": "array"
},
"regex": {
"description": "正则表达式搜索(与 keyword 互斥)",
"type": "string"
},
"search_in": {
"default": "all",
"description": "搜索范围",
"enum": [
"path",
"summary",
"description",
"tags",
"all"
],
"type": "string"
},
"tags": {
"description": "按标签过滤,支持多个标签(OR 关系)",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [],
"type": "object"
}