Lib.rs

› 网络编程
#api-client #http-request #post #open-api

indexea

Indexea 的 OpenAPI

所有者：Indexea.

1 个稳定版本

1.0.0 2023年9月24日

#48 在 #post

MIT 许可证

515KB
8K SLoC

indexea 的 Rust API 客户端

Indexea 的 OpenAPI

更多信息，请访问 https://indexea.com/about

概述

此 API 客户端由 OpenAPI Generator 项目生成。通过使用来自远程服务器的 openapi-spec，您可以轻松生成 API 客户端。

  • API 版本：1.0.0
  • 包版本：1.0
  • 构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放入名为 indexea 的目录中，并将其添加到项目文件夹中，然后在 Cargo.toml 中的 [dependencies]

indexea = { path = "./indexea" }

API 端点文档

所有 URI 都相对于 https://api.indexea.com/v1

类 方法 HTTP 请求 描述
AccountApi account_period_bulletin GET /accounts/bulletin 获取系统公告
AccountApi account_period_delete DELETE /account/profile 注销账号
AccountApi account_period_delete_openid DELETE /account/openid 解绑三方账号
AccountApi account_period_openid GET /account/openid 获取绑定的所有三方账号
AccountApi account_period_passwd POST /account/passwd 修改账号密码
AccountApi account_period_portrait POST /account/portrait 修改账号头像
AccountApi account_period_profile GET /account/profile 获取登录账号信息
AccountApi account_period_reset_pwd POST /account/reset-pwd 重置账号密码
AccountApi account_period_send_verify_code GET /account/send-verify-code 发送账号验证码
AccountApi account_period_signin POST /account/signin 登录系统
AccountApi account_period_signout POST /account/sign-out 退出登录状态
AccountApi account_period_signup POST /account/signup 注册新账号
AccountApi account_period_update POST /account/profile 修改账号资料
AccountApi account_period_update_settings POST /account/settings 修改账号设置
AppsApi app_period_add_mentor POST /apps/{app}/mentors 添加应用成员
AppsApi app_period_blacklist GET /apps/{app}/blacklist 获取黑名单信息
AppsApi app_period_create POST /apps 创建应用
AppsApi app_period_create_access_token POST /apps/{app}/tokens 创建访问令牌
AppsApi app_period_create_oauth_app POST /apps/{app}/oauth 创建第三方应用
AppsApi app_period_delete DELETE /apps/{app} 删除应用
AppsApi app_period_delete_access_token DELETE /apps/{app}/tokens 删除访问令牌
AppsApi app_period_delete_mentor DELETE /apps/{app}/mentors 删除应用成员
AppsApi app_period_delete_oauth_app DELETE /apps/{app}/oauth 删除第三方应用
AppsApi app_period_excel_of_logs GET /apps/{app}/logs 导出应用日志到 Excel
AppsApi app_period_get GET /apps/{app} 获取应用详情
AppsApi app_period_get_company POST /apps/{app}/company 获取应用填写的公司信息
AppsApi app_period_get_company_pic GET /apps/{app}/company 获取公司营业执照或者一般纳税人证明
AppsApi app_period_list GET /apps 获取应用列表
AppsApi app_period_list_mentors GET /apps/{app}/mentors 获取应用成员列表
AppsApi app_period_list_oauth_apps GET /apps/{app}/oauth 获取第三方应用列表
AppsApi app_period_logs POST /apps/{app}/logs 获取应用的日志列表
AppsApi app_period_reset_access_token PATCH /apps/{app}/tokens 重置 Access Token
AppsApi app_period_reset_oauth_app_secret POST /apps/{app}/oauth-reset-secret 重新生成三方应用的密钥
AppsApi app_period_save_blacklist PUT /apps/{app}/blacklist 修改应用的黑名单信息
AppsApi app_period_save_company PUT /apps/{app}/company 修改应用的公司信息
AppsApi app_period_searchs_estimate GET /apps/{app}/searchs-estimate 获取搜索流量包使用配额信息
AppsApi app_period_set_trigger PUT /apps/{app}/trigger 修改应用的触发器信息
AppsApi app_period_tokens GET /apps/{app}/tokens 获取 Access Token 列表
AppsApi app_period_transfer POST /apps/{app}/transfer 转让应用给他人
AppsApi app_period_trigger GET /apps/{app}/trigger 获取应用触发器详情
AppsApi app_period_trigger_logs GET /apps/{app}/trigger-logs 获取应用触发日志列表
AppsApi app_period_update PUT /apps/{app} 修改应用的基本信息
AppsApi app_period_update_access_token PUT /apps/{app}/tokens 修改 Access Token
AppsApi app_period_update_mentor PATCH /apps/{app}/mentors 修改成员备注和权限
AppsApi app_period_update_mentor_options POST /apps/{app}/mentors-options 修改应用成员自身的设置（包括应用名备注，是否接收报告等）
AppsApi app_period_update_mentor_report_options PATCH /apps/{app}/mentors-options 修改应用成员自身的通知设置
AppsApi app_period_update_oauth_app PATCH /apps/{app}/oauth 修改第三方应用信息
AppsApi app_period_update_oauth_app_logo PUT /apps/{app}/oauth 修改三方应用图标
AppsApi app_period_update_status PATCH /apps/{app} 修改应用的状态
FieldsApi index_period_fields GET /indices/{app}/{index}/fields 获取索引字段映射详情
FieldsApi index_period_update_fields POST /indices/{app}/{index}/fields 更新索引的字段映射
FieldsApi index_period_update_html_strip_fields PATCH /indices/{app}/{index}/fields 更新索引的HTML过滤字段列表
FieldsApi index_period_values_of_field GET /indices/{app}/{index}/fields/{field} 获取索引字段的所有值列表
GlobalApi json GET /json 接口定义(JSON)
GlobalApi options_period_get GET /options 系统全局配置接口
GlobalApi welcome GET / 接口欢迎信息
GlobalApi yaml GET /yaml 接口定义(YAML)
IndicesApi index_period_cleanup POST /indices/{app}/{index}/cleanup 清空索引记录
IndicesApi index_period_copy_to POST /indices/{app}/{index}/copyto 导出索引数据
IndicesApi index_period_create POST /indices/{app} 创建索引
IndicesApi index_period_create_template POST /indices/templates 创建索引模板
IndicesApi index_period_delete DELETE /indices/{app}/{index} 删除索引
IndicesApi index_period_delete_crawler_task DELETE /indices/{app}/{index}/crawler-settings 删除索引的数据爬取任务
IndicesApi index_period_delete_template DELETE /indices/templates 删除索引模板
IndicesApi index_period_export POST /indices/{app}/{index}/export 导出索引数据
IndicesApi index_period_flush POST /indices/{app}/{index}/flush 清空索引记录
IndicesApi index_period_flush_settings PUT /indices/{app}/{index}/settings 写入设置信息到索引
IndicesApi index_period_get GET /indices/{app}/{index} 获取单个索引详情
IndicesApi index_period_get_crawler_logs GET /indices/{app}/{index}/crawler-logs 获取索引的爬虫任务的爬取日志
IndicesApi index_period_get_crawler_task GET /indices/{app}/{index}/crawler-settings 获取索引的爬虫任务设定
IndicesApi index_period_get_filter_settings GET /indices/{app}/{index}/filter-settings 获取索引设置信息
IndicesApi index_period_get_settings GET /indices/{app}/{index}/settings 获取索引设置信息
IndicesApi index_period_list GET /indices/{app} 获取应用的索引列表
IndicesApi index_period_list_templates GET /indices/templates 获取所有可用的索引模板
IndicesApi index_period_prefetch GET /indices/crawler 获取目标网站内容预览
IndicesApi index_period_rebuild POST /indices/{app}/{index}/rebuild 重建索引数据
IndicesApi index_period_rebuild_task GET /indices/{app}/{index}/rebuild 获取重建索引任务的详情
IndicesApi index_period_submit_crawler_task POST /indices/{app}/{index}/crawler-settings 提交或者更新索引的数据爬取任务
IndicesApi index_period_update PUT /indices/{app}/{index} 修改索引
IndicesApi index_period_update_settings POST /indices/{app}/{index}/settings 更新索引设置信息
IndicesApi index_period_update_template PUT /indices/templates 修改索引模板
IndicesApi synonyms_period_add POST /indices/{app}/{index}/synonyms 添加同义词
IndicesApi synonyms_period_delete DELETE /indices/{app}/{index}/synonyms 删除同义词
IndicesApi synonyms_period_enable PATCH /indices/{app}/{index}/synonyms 启用禁用同义词
IndicesApi synonyms_period_flush POST /indices/{app}/{index}/synonyms-flush 将同义词更新到搜索引擎的同义词表
IndicesApi synonyms_period_import POST /indices/{app}/{index}/synonyms-import 导入同义词
IndicesApi synonyms_period_list GET /indices/{app}/{index}/synonyms 获取索引的所有同义词
IndicesApi synonyms_period_update PUT /indices/{app}/{index}/synonyms 修改同义词
MessageApi message_period_delete DELETE /accounts/message 删除消息
MessageApi message_period_feedback POST /accounts/feedback 反馈意见
MessageApi message_period_list GET /accounts/message 获取与我相关的消息信息，包括未读消息数量、最新消息等
MessageApi message_period_read PATCH /accounts/message 标识消息为已读
MessageApi message_period_send POST /accounts/message 发送消息
PaymentApi payment_period_alipay POST /payment/alipay 接受支付宝的支付结果
PaymentApi payment_period_alipay_return GET /payment/alipay 支付宝平台支付完成后调整到该接口
PaymentApi payment_period_apply_invoice POST /payment/{app}/invoices 申请发票
PaymentApi payment_period_begin_pay POST /payment/{app}/orders/{ident} 支付订单
PaymentApi payment_period_buy PUT /payment/{app}/orders 下单购买
PaymentApi payment_period_delete_invoice DELETE /payment/{app}/invoices 删除发票
PaymentApi payment_period_delete_order DELETE /payment/{app}/orders/{ident} 取消订单
PaymentApi payment_period_invoices GET /payment/{app}/invoices 获取发票列表
PaymentApi payment_period_order GET /payment/{app}/orders/{ident} 获取订单详情
PaymentApi payment_period_orders POST /payment/{app}/orders 订单列表
PaymentApi payment_period_orders_without_invoice GET /payment/{app}/orders_without_invoice 获取未曾开票的订单列表
PaymentApi payment_period_price GET /payment/{app}/price 获取套餐价格
PaymentApi payment_period_receipt GET /payment/{app}/orders 获取订单回执图片
PaymentApi payment_period_request_contact POST /payment/{app}/contact 联系销售获取私有化报价
PaymentApi payment_period_upload_receipt PUT /payment/{app}/orders/{ident} 上传转账回执
PaymentApi payment_period_wepay POST /payment/wepay 接受微信支付的支付结果
QueriesApi query_period_analyze POST /queries/{app}/analyze 分词测试
QueriesApi query_period_copy POST /queries/{app}/copy 复制指定查询并创建新查询
QueriesApi query_period_copy_to_query PUT /queries/{app}/copy 复制查询到已有查询
QueriesApi query_period_create POST /queries/{app} 创建搜索
QueriesApi query_period_create_keyword_bindings POST /queries/{app}/keyword-bindings 创建新的关键词文档绑定
QueriesApi query_period_create_variable POST /queries/{app}/variables 创建新的预定义查询变量
QueriesApi query_period_delete DELETE /queries/{app} 删除搜索
QueriesApi query_period_delete_keyword_bindings DELETE /queries/{app}/keyword-bindings 删除关键词文档绑定
QueriesApi query_period_delete_variable DELETE /queries/{app}/variables 删除预定义查询变量
QueriesApi query_period_fields GET /queries/{app}/fields 获取查询关联的所有索引的字段信息
QueriesApi query_period_get GET /queries/{app}/{query} 获取查询的详情
QueriesApi query_period_get_record GET /queries/{app}/record 获取记录的详情
QueriesApi query_period_keyword_bindings GET /queries/{app}/keyword-bindings 获取查询的关键词文档绑定列表
QueriesApi query_period_list GET /queries/{app} 获取应用下所有索引下的查询列表（按索引进行分组）
QueriesApi 查询周期配置 GET /queries/{app}/profiler 获取搜索诊断信息
QueriesApi 查询周期关键词绑定记录 GET /queries/{app}/keyword-bindings-records 获取关键词绑定对应的记录列表
QueriesApi 查询周期智能映射保存 PUT /queries/{app}/intelligent-mappings 设置索引智能匹配字段
QueriesApi 查询周期搜索 GET /queries/{app}/search 搜索测试
QueriesApi 查询周期源码 POST /queries/{app}/{query} 获取最终查询的源码(JSON)
QueriesApi 查询周期建议 GET /queries/{app}/suggest 获取搜索建议列表
QueriesApi 查询周期智能映射测试 POST /queries/{app}/intelligent-mappings 测试索引智能匹配字段
QueriesApi 查询周期更新 PUT /queries/{app} 修改查询
QueriesApi 查询周期更新关键词绑定 PATCH /queries/{app}/keyword-bindings 修改关键词文档绑定
QueriesApi 查询周期更新设置 POST /queries/{app}/settings 更改查询的设置项
QueriesApi 查询周期更新变量 PATCH /queries/{app}/variables 修改预定义查询变量
QueriesApi 查询周期验证 GET /queries/{app}/validate 获取搜索验证结果
QueriesApi 查询周期验证聚合 POST /queries/{app}/validate-aggregation 验证聚合定义是否正确
QueriesApi 查询周期验证查询 POST /queries/{app}/validate-query 验证聚合定义是否正确
QueriesApi 查询周期验证脚本字段 POST /queries/{app}/validate-script-field 验证脚本字段是否正确
QueriesApi 查询周期验证脚本评分 POST /queries/{app}/validate-script-score 验证脚本字段是否正确
QueriesApi 查询周期验证建议 POST /queries/{app}/validate-suggest 验证建议是否正确
QueriesApi 查询周期变量 GET /queries/{app}/variables 获取应用的预定义查询变量列表
推荐API 推荐周期点击 POST /recommend/{ident}/click 推荐结果点击行为收集
推荐API 推荐周期创建 POST /recommends/{app} 创建新的推荐
推荐API 推荐周期删除 DELETE /recommends/{app} 删除推荐
推荐API 推荐周期详情 GET /recommend/{ident} 获取推荐的记录列表
推荐API 推荐周期获取 POST /recommend/{ident} 获取推荐的记录列表
推荐API 推荐周期列表 GET /recommends/{app} 获取已定义的推荐列表
推荐API 推荐周期更新 PUT /recommends/{app} 更新推荐信息
记录API 记录周期删除 DELETE /records/{app}/{index} 删除记录数据
记录API 记录周期获取 GET /records/{app}/{index} 获取单条记录详情
记录API 记录周期列表 POST /records/{app}/{index} 获取索引记录列表
记录API 记录周期推送 PUT /records/{app}/{index} 插入或者更新索引数据
记录API 记录周期上传 POST /records/{app}/{index}/upload 上传记录
搜索API 搜索周期点击 POST /search/widget/{widget}/click 搜索结果点击行为收集
搜索API 搜索周期历史记录 GET /search/widget/{widget}/histories 获取当前搜索用户的最新搜索记录
搜索API 搜索周期日志 GET /apps/{app}/logs-searchs 获取搜索日志
搜索API 搜索周期查询历史记录 GET /search/query/{query}/histories 获取当前搜索用户的最新搜索记录
搜索API 搜索周期查询热门词汇 GET /search/query/{query}/hotwords 获取查询相关热门词汇
搜索API 搜索周期查询搜索 GET /search/query/{query} 基于查询的公开搜索
搜索API 搜索周期组件自动完成 GET /search/widget/{widget}/autocomplete 基于组件的搜索词自动完成
搜索API 搜索周期组件热门词汇 GET /search/widget/{widget}/hotwords 获取组件搜索的相关热门词汇
搜索API 搜索周期组件搜索 GET /search/widget/{widget} 基于组件的公开搜索
统计API 统计周期推荐 GET /stats/{app}/recomms 获取推荐日志的汇总信息
统计API 统计周期搜索 GET /stats/{app}/searchs 获取搜索日志的汇总信息
统计API 统计周期点击排行榜 GET /stats/{app}/top-clicks 获取点击排行榜
统计API 统计周期组件 GET /stats/{app}/widgets 获取模板与组件的统计信息
组件API 组件周期复制 POST /widget/{app}/copy 复制指定组件并创建新组件
组件API 组件周期复制到组件 PUT /widget/{app}/copy 复制组件到已有组件
组件API 组件周期创建 POST /widgets/{app} 创建组件
组件API 组件周期删除 DELETE /widgets/{app}/{widget} 删除组件
组件API 组件周期详情 GET /widget/{ident} 获取UI组件的所有相关信息
组件API 组件周期下载 GET /widgets/{app}/{widget}/download 下载组件应用源码
组件API widget_period_get GET /widgets/{app}/{widget} 获取组件的详情
组件API widget_period_list GET /widgets/{app} 获取应用的组件列表
组件API widget_period_logo POST /widgets/{app}/{widget}/logo 设置组件 Logo
组件API widget_period_update PUT /widgets/{app}/{widget} 修改组件
组件API widget_period_update_settings PATCH /widgets/{app}/{widget} 修改组件设置参数

模型文档说明

要获取生成的文档，请使用

cargo doc --open

作者

[email protected]

依赖项

~4-19MB
~242K SLoC