Lib.rs

› 网页编程 › Typesense
#search #generated #client #api-client #codegen #openapi #typesense

typesense_codegen

使用 openapi 规范生成的 Typesense 客户端

由 OpenAPI Generator 团队和贡献者创建。 所有者 morenol.

1 个不稳定版本

0.23.0 2022 年 8 月 4 日

#133 in #codegen


在 typesense 中使用

Apache-2.0

190KB
3.5K SLoC

Rust 的 openapi API 客户端

一个开源搜索引擎，用于构建愉悦的搜索体验。

概览

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

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

安装

将包放在您的项目文件夹中名为 openapi 的目录下，并在 Cargo.toml 中的 [dependencies] 下添加以下内容

openapi = { path = "./openapi" }

API 端点文档

所有 URI 都是相对于 http://localhost

类 方法 HTTP 请求 描述
CollectionsApi create_collection POST /collections 创建一个新的集合
CollectionsApi delete_alias DELETE /aliases/{aliasName} 删除一个别名
CollectionsApi delete_collection DELETE /collections/{collectionName} 删除一个集合
CollectionsApi get_alias GET /aliases/{aliasName} 检索一个别名
CollectionsApi get_aliases GET /aliases 列出所有别名
CollectionsApi get_collection GET /collections/{collectionName} 检索单个集合
CollectionsApi get_collections GET /collections 列出所有集合
CollectionsApi update_collection PATCH /collections/{collectionName} 更新一个集合
CollectionsApi upsert_alias PUT /aliases/{aliasName} 创建或更新集合别名
DebugApi debug GET /debug 打印调试信息
DocumentsApi delete_document DELETE /collections/{collectionName}/documents/{documentId} 删除一个文档
DocumentsApi delete_documents DELETE /collections/{collectionName}/documents 删除多个文档
DocumentsApi delete_search_override DELETE /collections/{collectionName}/overrides/{overrideId} 删除与集合关联的重写
DocumentsApi delete_search_synonym DELETE /collections/{collectionName}/synonyms/{synonymId} 删除与集合关联的同义词
DocumentsApi export_documents GET /collections/{collectionName}/documents/export 导出集合中的所有文档
DocumentsApi get_document GET /collections/{collectionName}/documents/{documentId} 检索文档
DocumentsApi get_search_override GET /collections/{collectionName}/overrides/{overrideId} 检索单个搜索重写
DocumentsApi get_search_overrides GET /collections/{collectionName}/overrides 列出所有集合重写
DocumentsApi get_search_synonym GET /collections/{collectionName}/synonyms/{synonymId} 检索单个搜索同义词
DocumentsApi get_search_synonyms GET /collections/{collectionName}/synonyms 列出所有集合同义词
DocumentsApi import_documents POST /collections/{collectionName}/documents/import 将文档导入集合
DocumentsApi index_document POST /collections/{collectionName}/documents 索引文档
DocumentsApi multi_search POST /multi_search 在单个HTTP请求中发送多个搜索请求
DocumentsApi search_collection GET /collections/{collectionName}/documents/search 在集合中搜索文档
DocumentsApi update_document PATCH /collections/{collectionName}/documents/{documentId} 更新文档
DocumentsApi upsert_search_override PUT /collections/{collectionName}/overrides/{overrideId} 创建或更新重写以提升某些文档
DocumentsApi upsert_search_synonym PUT /collections/{collectionName}/synonyms/{synonymId} 创建或更新同义词
HealthApi health GET /health 检查Typesense服务器是否准备好接受请求。
KeysApi create_key POST /keys 创建API密钥
KeysApi delete_key DELETE /keys/{keyId} 根据其ID删除API密钥。
KeysApi get_key GET /keys/{keyId} 检索（有关密钥的元数据）
KeysApi get_keys GET /keys 检索（有关所有密钥的元数据）。
OperationsApi take_snapshot POST /operations/snapshot 在指定的目录中创建Typesense节点状态和数据的点时间快照。
OperationsApi vote POST /operations/vote 触发跟随节点启动raft投票过程，这会触发领导者重新选举。
OverrideApi get_search_override GET /collections/{collectionName}/overrides/{overrideId} 检索单个搜索重写
PromoteApi delete_search_override DELETE /collections/{collectionName}/overrides/{overrideId} 删除与集合关联的重写
PromoteApi get_search_overrides GET /collections/{collectionName}/overrides 列出所有集合重写
PromoteApi upsert_search_override PUT /collections/{collectionName}/overrides/{overrideId} 创建或更新重写以提升某些文档

模型文档说明

要获取crate生成的文档的访问权限，请使用

cargo doc --open

作者

依赖关系

~4–19MB
~248K SLoC