Lib.rs

› 网页编程
#netlify #api-client #http-client #web-client #deployment #service #oauth

netlify-rust

Netlify 的 HTTP 客户端

作者：Brad

2 个版本

0.1.1 2021年8月25日
0.1.0 2021年8月25日

#1542 in 网页编程

无版权

400KB
5.5K SLoC

Rust API 客户端用于 openapi

Netlify 是一个可编程网页的托管服务。它理解您的文档，并提供 API 来处理网站的原子部署、管理表单提交、注入 JavaScript 片段等。这是一个使用 JSON 进行序列化和 OAuth 2 进行认证的 REST 风格 API。

此文档是 Netlify API 的 OpenAPI 参考，您可以进行探索。有关常见使用的更详细说明，请访问 在线文档。访问我们的社区论坛加入关于 理解和使用 Netlify 的 API 的讨论。

此外，我们还提供两个 API 客户端以方便您使用

概述

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

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

安装

将包放入您的项目文件夹中，并将以下内容添加到 Cargo.toml 中的 [dependencies]

    openapi = { path = "./generated" }

API 端点文档

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

类 方法 HTTP 请求 描述
AccessTokenApi exchange_ticket POST /oauth/tickets/{ticket_id}/exchange
AccountMembershipApi cancel_account DELETE /accounts/{account_id}
AccountMembershipApi create_account POST /accounts
AccountMembershipApi get_account GET /accounts/{account_id}
AccountMembershipApi list_accounts_for_user GET /accounts
AccountMembershipApi update_account PUT /accounts/{account_id}
AccountTypeApi list_account_types_for_user GET /accounts/types
AssetApi create_site_asset POST /sites/{site_id}/assets
AssetApi delete_site_asset DELETE /sites/{site_id}/assets/{asset_id}
AssetApi get_site_asset_info GET /sites/{site_id}/assets/{asset_id}
AssetApi list_site_assets GET /sites/{site_id}/assets
AssetApi update_site_asset PUT /sites/{site_id}/assets/{asset_id}
AssetPublicSignatureApi get_site_asset_public_signature GET /sites/{site_id}/assets/{asset_id}/public_signature
AuditLogApi list_account_audit_events GET /accounts/{account_id}/audit
BuildApi create_site_build POST /sites/{site_id}/builds
BuildApi get_account_build_status GET /{account_id}/builds/status
BuildApi 获取站点构建 GET /builds/{build_id}
BuildApi 列出站点构建 GET /sites/{site_id}/builds
BuildApi 通知构建开始 POST /builds/{build_id}/start
BuildHookApi 创建站点构建钩子 POST /sites/{site_id}/build_hooks
BuildHookApi 删除站点构建钩子 DELETE /sites/{site_id}/build_hooks/{id}
BuildHookApi 获取站点构建钩子 GET /sites/{site_id}/build_hooks/{id}
BuildHookApi 列出站点构建钩子 GET /sites/{site_id}/build_hooks
BuildHookApi 更新站点构建钩子 PUT /sites/{site_id}/build_hooks/{id}
BuildLogMsgApi 更新站点构建日志 POST /builds/{build_id}/log
DeployApi 取消站点部署 POST /deploys/{deploy_id}/cancel
DeployApi 创建站点部署 POST /sites/{site_id}/deploys
DeployApi 获取部署 GET /deploys/{deploy_id}
DeployApi 获取站点部署 GET /sites/{site_id}/deploys/{deploy_id}
DeployApi 列出站点部署 GET /sites/{site_id}/deploys
DeployApi 锁定部署 POST /deploys/{deploy_id}/lock
DeployApi 恢复站点部署 POST /sites/{site_id}/deploys/{deploy_id}/restore
DeployApi 回滚站点部署 PUT /sites/{site_id}/rollback
DeployApi 解锁部署 POST /deploys/{deploy_id}/unlock
DeployApi 更新站点部署 PUT /sites/{site_id}/deploys/{deploy_id}
DeployKeyApi 创建部署密钥 POST /deploy_keys
DeployKeyApi 删除部署密钥 DELETE /deploy_keys/{key_id}
DeployKeyApi 获取部署密钥 GET /deploy_keys/{key_id}
DeployKeyApi 列出部署密钥 GET /deploy_keys
DeployedBranchApi 列出站点已部署分支 GET /sites/{site_id}/deployed-branches
DnsZoneApi 为站点配置DNS PUT /sites/{site_id}/dns
DnsZoneApi 创建DNS记录 POST /dns_zones/{zone_id}/dns_records
DnsZoneApi 创建DNS区域 POST /dns_zones
DnsZoneApi 删除DNS记录 DELETE /dns_zones/{zone_id}/dns_records/{dns_record_id}
DnsZoneApi 删除DNS区域 DELETE /dns_zones/{zone_id}
DnsZoneApi 获取站点的DNS GET /sites/{site_id}/dns
DnsZoneApi 获取DNS记录 GET /dns_zones/{zone_id}/dns_records
DnsZoneApi 获取DNS区域 GET /dns_zones/{zone_id}
DnsZoneApi 获取DNS区域列表 GET /dns_zones
DnsZoneApi 获取单个DNS记录 GET /dns_zones/{zone_id}/dns_records/{dns_record_id}
DnsZoneApi 转让DNS区域 PUT /dns_zones/{zone_id}/transfer
FileApi 通过路径名获取站点文件 GET /sites/{site_id}/files/{file_path}
FileApi 列出站点文件 GET /sites/{site_id}/files
FileApi 上传部署文件 PUT /deploys/{deploy_id}/files/{path}
FormApi 删除站点表单 DELETE /sites/{site_id}/forms/{form_id}
FormApi 列出站点表单 GET /sites/{site_id}/forms
FunctionApi 上传部署函数 PUT /deploys/{deploy_id}/functions/{name}
HookApi 根据站点ID创建钩子 POST /hooks
HookApi 删除钩子 DELETE /hooks/{hook_id}
HookApi 启用钩子 POST /hooks/{hook_id}/enable
HookApi 获取钩子 GET /hooks/{hook_id}
HookApi 根据站点ID列出钩子 GET /hooks
HookApi 更新钩子 PUT /hooks/{hook_id}
HookTypeApi 列出钩子类型 GET /hooks/types
MemberApi 向账户添加成员 POST /{account_slug}/members
MemberApi 列出账户成员 GET /{account_slug}/members
MetadataApi 获取站点元数据 GET /sites/{site_id}/metadata
MetadataApi 更新站点元数据 PUT /sites/{site_id}/metadata
PaymentMethodApi 列出用户的支付方式 GET /billing/payment_methods
ServiceApi 获取服务 GET /services/
ServiceApi 显示服务 GET /services/{addonName}
ServiceApi 显示服务清单 GET /services/{addonName}/manifest
ServiceInstanceApi 创建服务实例 POST /sites/{site_id}/services/{addon}/instances
ServiceInstanceApi 删除服务实例 DELETE /sites/{site_id}/services/{addon}/instances/{instance_id}
ServiceInstanceApi 列出站点服务实例 GET /sites/{site_id}/service-instances
ServiceInstanceApi 显示服务实例 GET /sites/{site_id}/services/{addon}/instances/{instance_id}
ServiceInstanceApi 更新服务实例 PUT /sites/{site_id}/services/{addon}/instances/{instance_id}
SiteApi create_site POST /sites
SiteApi create_site_in_team POST /{account_slug}/sites
SiteApi delete_site DELETE /sites/{site_id}
SiteApi get_site GET /sites/{site_id}
SiteApi list_sites GET /sites
SiteApi list_sites_for_account GET /{account_slug}/sites
SiteApi unlink_site_repo PUT /sites/{site_id}/unlink_repo
SiteApi update_site PATCH /sites/{site_id}
SniCertificateApi provision_site_tls_certificate POST /sites/{site_id}/ssl
SniCertificateApi show_site_tls_certificate GET /sites/{site_id}/ssl
SnippetApi create_site_snippet POST /sites/{site_id}/snippets
SnippetApi delete_site_snippet DELETE /sites/{site_id}/snippets/{snippet_id}
SnippetApi get_site_snippet GET /sites/{site_id}/snippets/{snippet_id}
SnippetApi list_site_snippets GET /sites/{site_id}/snippets
SnippetApi update_site_snippet PUT /sites/{site_id}/snippets/{snippet_id}
SplitTestApi create_split_test POST /sites/{site_id}/traffic_splits
SplitTestApi disable_split_test POST /sites/{site_id}/traffic_splits/{split_test_id}/unpublish
SplitTestApi enable_split_test POST /sites/{site_id}/traffic_splits/{split_test_id}/publish
SplitTestApi get_split_test GET /sites/{site_id}/traffic_splits/{split_test_id}
SplitTestApi get_split_tests GET /sites/{site_id}/traffic_splits
SplitTestApi update_split_test PUT /sites/{site_id}/traffic_splits/{split_test_id}
SubmissionApi delete_submission DELETE /submissions/{submission_id}
SubmissionApi list_form_submission GET /submissions/{submission_id}
SubmissionApi list_form_submissions GET /forms/{form_id}/submissions
SubmissionApi list_site_submissions GET /sites/{site_id}/submissions
TicketApi create_ticket POST /oauth/tickets
TicketApi show_ticket GET /oauth/tickets/{ticket_id}
UserApi get_current_user GET /user
XInternalApi create_plugin_run POST /deploys/{deploy_id}/plugin_runs
XInternalApi get_latest_plugin_runs GET /sites/{site_id}/plugin_runs/latest
XInternalApi update_plugin PUT /sites/{site_id}/plugins/{package}

Documentation For Models

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

cargo doc --open

作者

依赖关系

约4-19MB
约247K SLoC