1 stable release
| 1.0.0 | Sep 24, 2023 |
|---|
#37 in #post
515KB
8K
SLoC
Rust API client for indexea
OpenAPI of Indexea
For more information, please visit https://indexea.com/about
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 1.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named indexea and add the following to Cargo.toml under [dependencies]:
indexea = { path = "./indexea" }
Documentation for API Endpoints
All URIs are relative to https://api.indexea.com/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| 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 | 创建 Access Token |
| 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 | 删除 Access Token |
| 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 | query_period_profile | GET /queries/{app}/profiler | 获取搜索诊断信息 |
| QueriesApi | query_period_records_of_keyword_binding | GET /queries/{app}/keyword-bindings-records | 获取关键词绑定对应的记录列表 |
| QueriesApi | query_period_save_intelligent_mappings | PUT /queries/{app}/intelligent-mappings | 设置索引智能匹配字段 |
| QueriesApi | query_period_search | GET /queries/{app}/search | 搜索测试 |
| QueriesApi | query_period_source | POST /queries/{app}/{query} | 获取最终查询的源码(JSON) |
| QueriesApi | query_period_suggest | GET /queries/{app}/suggest | 获取搜索建议列表 |
| QueriesApi | query_period_test_intelligent_mappings | POST /queries/{app}/intelligent-mappings | 测试索引智能匹配字段 |
| QueriesApi | query_period_update | PUT /queries/{app} | 修改查询 |
| QueriesApi | query_period_update_keyword_bindings | PATCH /queries/{app}/keyword-bindings | 修改关键词文档绑定 |
| QueriesApi | query_period_update_settings | POST /queries/{app}/settings | 更改查询的设置项 |
| QueriesApi | query_period_update_variable | PATCH /queries/{app}/variables | 修改预定义查询变量 |
| QueriesApi | query_period_validate | GET /queries/{app}/validate | 获取搜索验证结果 |
| QueriesApi | query_period_validate_aggregation | POST /queries/{app}/validate-aggregation | 验证聚合定义是否正确 |
| QueriesApi | query_period_validate_query | POST /queries/{app}/validate-query | 验证聚合定义是否正确 |
| QueriesApi | query_period_validate_script_field | POST /queries/{app}/validate-script-field | 验证脚本字段是否正确 |
| QueriesApi | query_period_validate_script_score | POST /queries/{app}/validate-script-score | 验证脚本字段是否正确 |
| QueriesApi | query_period_validate_suggestion | POST /queries/{app}/validate-suggest | 验证建议是否正确 |
| QueriesApi | query_period_variables | GET /queries/{app}/variables | 获取应用的预定义查询变量列表 |
| RecommendApi | recommend_period_click | POST /recommend/{ident}/click | 推荐结果点击行为收集 |
| RecommendApi | recommend_period_create | POST /recommends/{app} | 创建新的推荐 |
| RecommendApi | recommend_period_delete | DELETE /recommends/{app} | 删除推荐 |
| RecommendApi | recommend_period_detail | GET /recommend/{ident} | 获取推荐的记录列表 |
| RecommendApi | recommend_period_fetch | POST /recommend/{ident} | 获取推荐的记录列表 |
| RecommendApi | recommend_period_list | GET /recommends/{app} | 获取已定义的推荐列表 |
| RecommendApi | recommend_period_update | PUT /recommends/{app} | 更新推荐信息 |
| RecordsApi | record_period_delete | DELETE /records/{app}/{index} | 删除记录数据 |
| RecordsApi | record_period_get | GET /records/{app}/{index} | 获取单条记录详情 |
| RecordsApi | record_period_list | POST /records/{app}/{index} | 获取索引记录列表 |
| RecordsApi | record_period_push | PUT /records/{app}/{index} | 插入或者更新索引数据 |
| RecordsApi | record_period_upload | POST /records/{app}/{index}/upload | 上传记录 |
| SearchApi | search_period_click | POST /search/widget/{widget}/click | 搜索结果点击行为收集 |
| SearchApi | search_period_histories | GET /search/widget/{widget}/histories | 获取当前搜索用户的最新搜索记录 |
| SearchApi | search_period_logs | GET /apps/{app}/logs-searchs | 获取搜索日志 |
| SearchApi | search_period_query_histories | GET /search/query/{query}/histories | 获取当前搜索用户的最新搜索记录 |
| SearchApi | search_period_query_hot_words | GET /search/query/{query}/hotwords | 获取查询相关热词 |
| SearchApi | search_period_query_search | GET /search/query/{query} | 基于查询的公开搜索 |
| SearchApi | search_period_widget_auto_complete | GET /search/widget/{widget}/autocomplete | 基于组件的搜索词自动完成 |
| SearchApi | search_period_widget_hot_words | GET /search/widget/{widget}/hotwords | 获取组件搜索的相关热词 |
| SearchApi | search_period_widget_search | GET /search/widget/{widget} | 基于组件的公开搜索 |
| StatsApi | stats_period_recomms | GET /stats/{app}/recomms | 获取推荐日志的汇总信息 |
| StatsApi | stats_period_searchs | GET /stats/{app}/searchs | 获取搜索日志的汇总信息 |
| StatsApi | stats_period_top_clicks | GET /stats/{app}/top-clicks | 获取点击排行榜 |
| StatsApi | stats_period_widgets | GET /stats/{app}/widgets | 获取模板与组件的统计信息 |
| WidgetsApi | widget_period_copy | POST /widget/{app}/copy | 复制指定组件并创建新组件 |
| WidgetsApi | widget_period_copy_to_widget | PUT /widget/{app}/copy | 复制组件到已有组件 |
| WidgetsApi | widget_period_create | POST /widgets/{app} | 创建组件 |
| WidgetsApi | widget_period_delete | DELETE /widgets/{app}/{widget} | 删除组件 |
| WidgetsApi | widget_period_detail | GET /widget/{ident} | 获取UI组件的所有相关信息 |
| WidgetsApi | widget_period_download | GET /widgets/{app}/{widget}/download | 下载组件应用源码 |
| WidgetsApi | widget_period_get | GET /widgets/{app}/{widget} | 获取组件的详情 |
| WidgetsApi | widget_period_list | GET /widgets/{app} | 获取应用的组件列表 |
| WidgetsApi | widget_period_logo | POST /widgets/{app}/{widget}/logo | 设置组件 Logo |
| WidgetsApi | widget_period_update | PUT /widgets/{app}/{widget} | 修改组件 |
| WidgetsApi | widget_period_update_settings | PATCH /widgets/{app}/{widget} | 修改组件设置参数 |
Documentation For Models
- AccountBean
- AnalyzeObject
- AnalyzeToken
- AppBean
- AppLogAccount
- AppLogBean
- AppLogsBean
- AppMentorBean
- AutoCompleteItem
- BlacklistBean
- Bulletin
- CompanyBean
- ContactForm
- CrawlerLog
- CrawlerLogs
- CrawlerTask
- GlobalOptionForm
- IndexBean
- IndexFieldBean
- IndexForm
- IndexRebuildForm
- IndexSettings
- IndexStatBean
- IndexTask
- IndexTemplate
- IndexTemplates
- IntelligentMapping
- KeywordBindingBean
- MentorForm
- Message
- Messages
- OauthAppBean
- OpenidBean
- PayResult
- PaymentInvoice
- PaymentOrder
- PaymentRecord
- PaymentService
- QueryActionBean
- QueryBean
- QueryForm
- QuerySortField
- QueryVariableBean
- RecommendBean
- RecordFilter
- SearchEstimateResult
- SearchWord
- StatIndexBean
- SynonymsBean
- TokenBean
- TriggerBean
- TriggerLogBean
- ValueOfField
- WidgetBean
- WidgetForm
- WidgetLogo
- WidgetStatusForm
To get access to the crate's generated documentation, use:
cargo doc --open
Author
Dependencies
~5–20MB
~231K SLoC