6 个版本 (破坏性更新)
| 0.5.0 | 2023 年 3 月 24 日 |
|---|---|
| 0.4.1 | 2023 年 2 月 22 日 |
| 0.3.0 | 2023 年 2 月 4 日 |
| 0.2.0 | 2022 年 5 月 26 日 |
| 0.1.0 | 2022 年 4 月 29 日 |
#938 in 网页编程
1.5MB
24K SLoC
Rust API 客户端用于自然观察家
https://api.inaturalist.org/v1/
自然观察家是一个全球性的自然爱好者、科学家和公众的社区，分享超过一百万的野生动物观察，互相教授关于自然世界的同时，为科学和保育创建高质量的公民科学数据。自然观察家的技术基础设施和开源软件由加州科学院管理，作为他们探索、解释和维持地球生命使命的一部分。
这些 API 方法以 JSON/JSONP 和 PNG 响应格式返回数据。它们旨在补充现有的自然观察家 API，该 API 使用 Ruby on Rails 实现，功能更强大，支持更多写操作，但通常速度较慢，响应格式一致性较差。有关更多信息，请访问我们的开发者页面。描述期望和返回 JSON 的写操作将单个 body 参数作为请求体，该请求体应指定为 JSON。请参阅每个 body 参数的“模型”，了解我们接受这些 JSON 对象中的属性。
单个 URL 参数的多个值应通过逗号分隔，例如 taxon_id=1,2,3。
地图瓦片使用node-mapnik库生成，遵循 XYZ 地图瓦片方案。观察瓦片方法接受几乎所有观察搜索 API 的参数，并将生成反映搜索返回的相同观察的地图瓦片。这些“观察瓦片”方法有相应的 UTFGrid JSON 响应，返回制作交互式地图所需的信息。
节点 API 中的身份验证通过 JSON Web Tokens (JWT) 处理。要获取一个，请向OAuth 身份验证请求到 https://www.inaturalist.org/users/api_token。每个 JWT 将在 24 小时后过期。所有 PUT 和 POST 请求都需要身份验证。一些 GET 请求还将包括私人信息，如隐藏坐标，如果认证用户有权查看它们。
自然观察家网站： https://www.inaturalist.org/
开源软件: https://github.com/inaturalist/
使用条款
使用此API受iNaturalist 服务条款 和 隐私政策 的约束。未经通知，我们将阻止任何违反我们条款或隐私政策的API使用。API旨在支持应用程序开发，而不是数据抓取。有关预生成的数据导出，请参阅 https://www.inaturalist.org/pages/developers。
请注意，我们将API使用限制在每分钟最多100次请求，但我们建议您尽量保持在每分钟60次或更低，并且每天不超过10,000次请求。如果我们发现使用对我们的性能有严重影响，我们可能会在未通知的情况下实施封锁。
服务条款: https://www.inaturalist.org/terms
隐私政策: https://www.inaturalist.org/privacy
概述
此API客户端是由 OpenAPI Generator 项目生成的。通过使用远程服务器的 openapi-spec，您可以轻松生成API客户端。
- API版本: 1.3.0
- 包版本: 0.1.0
- 构建包:
org.openapitools.codegen.languages.RustClientCodegen
安装
将包放在名为 inaturalist 的目录下，并在 Cargo.toml 中的 [dependencies] 下添加以下内容：
inaturalist = { path = "./inaturalist" }
API端点文档
所有URI都是相对于 /v1
| 类 | 方法 | HTTP请求 | 描述 |
|---|---|---|---|
| AnnotationsApi | annotations_id_delete | DELETE /annotations/{id} | 删除注释 |
| AnnotationsApi | annotations_post | POST /annotations | 创建注释 |
| AnnotationsApi | votes_unvote_annotation_id_delete | DELETE /votes/unvote/annotation/{id} | 取消注释投票 |
| AnnotationsApi | votes_vote_annotation_id_post | POST /votes/vote/annotation/{id} | 投票注释 |
| CommentsApi | comments_id_delete | DELETE /comments/{id} | 删除评论 |
| CommentsApi | comments_id_put | PUT /comments/{id} | 更新评论 |
| CommentsApi | comments_post | POST /comments | 创建评论 |
| ControlledTermsApi | controlled_terms_for_taxon_get | GET /controlled_terms/for_taxon | 物种术语 |
| ControlledTermsApi | controlled_terms_get | GET /controlled_terms | 术语索引 |
| FlagsApi | flags_id_delete | DELETE /flags/{id} | 删除标记 |
| FlagsApi | flags_id_put | PUT /flags/{id} | 更新标记 |
| FlagsApi | flags_post | POST /flags | 创建标记 |
| IdentificationsApi | identifications_categories_get | GET /identifications/categories | 识别类别 |
| IdentificationsApi | identifications_get | GET /identifications | 识别搜索 |
| IdentificationsApi | identifications_id_delete | DELETE /identifications/{id} | 删除识别 |
| IdentificationsApi | identifications_id_get | GET /identifications/{id} | 识别详情 |
| IdentificationsApi | identifications_id_put | PUT /identifications/{id} | 更新识别 |
| IdentificationsApi | identifications_identifiers_get | GET /identifications/identifiers | 识别标识符 |
| IdentificationsApi | identifications_observers_get | GET /identifications/observers | 识别观察者 |
| IdentificationsApi | identifications_post | POST /identifications | 创建识别 |
| IdentificationsApi | identifications_recent_taxa_get | GET /identifications/recent_taxa | 最近识别的物种 |
| IdentificationsApi | identifications_similar_species_get | GET /identifications/similar_species | 相似物种 |
| IdentificationsApi | identifications_species_counts_get | GET /identifications/species_counts | 物种识别计数 |
| MessagesApi | messages_get | GET /messages | 检索认证用户的消息。这不会将它们标记为已读。 |
| MessagesApi | messages_id_delete | DELETE /messages/{id} | 删除消息/线程 |
| MessagesApi | messages_id_get | GET /messages/{id} | 检索线程中的消息 |
| MessagesApi | messages_post | POST /messages | 创建新消息 |
| MessagesApi | messages_unread_get | GET /messages/unread | 获取认证用户未读消息的数量 |
| ObservationFieldValuesApi | observation_field_values_id_delete | DELETE /observation_field_values/{id} | 观测字段值删除 |
| ObservationFieldValuesApi | observation_field_values_id_put | PUT /observation_field_values/{id} | 观测字段值更新 |
| ObservationFieldValuesApi | observation_field_values_post | POST /observation_field_values | 观测字段值创建 |
| ObservationPhotosApi | observation_photos_id_delete | DELETE /observation_photos/{id} | 观测照片删除 |
| ObservationPhotosApi | observation_photos_id_put | PUT /observation_photos/{id} | 观测照片更新 |
| ObservationPhotosApi | observation_photos_post | POST /observation_photos | 观测照片创建 |
| ObservationTilesApi | colored_heatmap_zoom_xy_png_get | GET /colored_heatmap/{zoom}/{x}/{y}.png | 彩色热力图瓦片 |
| ObservationTilesApi | grid_zoom_xy_png_get | GET /grid/{zoom}/{x}/{y}.png | 网格瓦片 |
| ObservationTilesApi | heatmap_zoom_xy_png_get | GET /heatmap/{zoom}/{x}/{y}.png | 热力图瓦片 |
| ObservationTilesApi | points_zoom_xy_png_get | GET /points/{zoom}/{x}/{y}.png | 点瓦片 |
| ObservationsApi | observations_deleted_get | GET /observations/deleted | 已删除观测 |
| ObservationsApi | observations_get | GET /observations | 观测搜索 |
| ObservationsApi | observations_histogram_get | GET /observations/histogram | 观测直方图 |
| ObservationsApi | observations_id_delete | DELETE /observations/{id} | 观测删除 |
| ObservationsApi | observations_id_fave_post | POST /observations/{id}/fave | 观测收藏 |
| ObservationsApi | observations_id_get | GET /observations/{id} | 观测详情 |
| ObservationsApi | observations_id_put | PUT /observations/{id} | 观测更新 |
| ObservationsApi | observations_id_quality_metric_delete | DELETE /observations/{id}/quality/{metric} | 质量指标删除 |
| ObservationsApi | observations_id_quality_metric_post | POST /observations/{id}/quality/{metric} | 质量指标设置 |
| ObservationsApi | observations_id_review_post | POST /observations/{id}/review | 观测评论 |
| ObservationsApi | observations_id_subscriptions_get | GET /observations/{id}/subscriptions | 观测订阅 |
| ObservationsApi | observations_id_taxon_summary_get | GET /observations/{id}/taxon_summary | 观测分类摘要 |
| ObservationsApi | observations_id_unfave_delete | DELETE /observations/{id}/unfave | 观测取消收藏 |
| ObservationsApi | observations_id_unreview_post | POST /observations/{id}/unreview | 观测取消评论 |
| ObservationsApi | observations_id_viewed_updates_put | PUT /observations/{id}/viewed_updates | 观测字段值更新 |
| ObservationsApi | 观测已查看更新 | observations_identifiers_get | GET /observations/identifiers |
| ObservationsApi | 观测标识符 | observations_observers_get | GET /observations/observers |
| ObservationsApi | 观测观察者 | observations_popular_field_values_get | GET /observations/popular_field_values |
| ObservationsApi | 观测流行字段值 | observations_post | POST /observations |
| ObservationsApi | 创建观测 | observations_species_counts_get | GET /observations/species_counts |
| ObservationsApi | 观测物种计数 | observations_updates_get | GET /observations/updates |
| ObservationsApi | 观测用户更新 | subscriptions_observation_id_subscribe_post | POST /subscriptions/observation/{id}/subscribe |
| ObservationsApi | 观测订阅 | votes_unvote_observation_id_delete | DELETE /votes/unvote/observation/{id} |
| ObservationsApi | 取消观测投票 | votes_vote_observation_id_post | POST /votes/vote/observation/{id} |
| 观测投票 | PhotosApi | POST /photos | 创建照片 |
| 地点API | places_autocomplete_get | GET /places/autocomplete | 地点自动补全 |
| 地点API | places_id_get | GET /places/{id} | 地点详情 |
| 地点API | places_nearby_get | GET /places/nearby | 附近地点 |
| 多边形瓦片API | places_place_id_zoom_xy_png_get | GET /places/{place_id}/{zoom}/{x}/{y}.png | 地点瓦片 |
| 多边形瓦片API | taxon_places_taxon_id_zoom_xy_png_get | GET /taxon_places/{taxon_id}/{zoom}/{x}/{y}.png | 分类地点瓦片 |
| 多边形瓦片API | taxon_ranges_taxon_id_zoom_xy_png_get | GET /taxon_ranges/{taxon_id}/{zoom}/{x}/{y}.png | 分类范围瓦片 |
| 帖子API | posts_for_user_get | GET /posts/for_user | 用户帖子 |
| 帖子API | posts_get | GET /posts | 帖子搜索 |
| 帖子API | posts_id_delete | DELETE /posts/{id} | 删除帖子 |
| 帖子API | posts_id_put | PUT /posts/{id} | 更新帖子 |
| 帖子API | posts_post | POST /posts | 创建帖子 |
| 项目观察API | project_observations_id_delete | DELETE /project_observations/{id} | 删除项目观察 |
| 项目观察API | project_observations_id_put | PUT /project_observations/{id} | 更新项目观察 |
| 项目观察API | project_observations_post | POST /project_observations | 创建项目观察 |
| 项目API | projects_autocomplete_get | GET /projects/autocomplete | 项目自动补全 |
| 项目API | projects_get | GET /projects | 项目搜索 |
| 项目API | projects_id_add_post | POST /projects/{id}/add | 添加项目 |
| 项目API | projects_id_get | GET /projects/{id} | 项目详情 |
| 项目API | projects_id_join_post | POST /projects/{id}/join | 加入项目 |
| 项目API | projects_id_leave_delete | DELETE /projects/{id}/leave | 离开项目 |
| 项目API | projects_id_members_get | GET /projects/{id}/members | 项目成员 |
| 项目API | projects_id_membership_get | GET /projects/{id}/membership | 当前用户的会员资格 |
| 项目API | projects_id_remove_delete | DELETE /projects/{id}/remove | 添加项目 |
| 项目API | projects_id_subscriptions_get | GET /projects/{id}/subscriptions | 项目订阅 |
| 项目API | subscriptions_project_id_subscribe_post | POST /subscriptions/project/{id}/subscribe | 项目订阅 |
| 搜索API | search_get | GET /search | 站点搜索 |
| 物种API | taxa_autocomplete_get | GET /taxa/autocomplete | 物种自动补全 |
| 物种API | taxa_get | GET /taxa | 物种搜索 |
| 物种API | taxa_id_get | GET /taxa/{id} | 物种详情 |
| UtfGridAPI | colored_heatmap_zoom_xy_grid_json_get | GET /colored_heatmap/{zoom}/{x}/{y}.grid.json | 彩色热图瓦片UTFGrid |
| UtfGridAPI | grid_zoom_xy_grid_json_get | GET /grid/{zoom}/{x}/{y}.grid.json | 网格瓦片UTFGrid |
| UtfGridAPI | heatmap_zoom_xy_grid_json_get | GET /heatmap/{zoom}/{x}/{y}.grid.json | 热图瓦片UTFGrid |
| UtfGridAPI | points_zoom_xy_grid_json_get | GET /points/{zoom}/{x}/{y}.grid.json | 点瓦片UTFGrid |
| 用户API | users_autocomplete_get | GET /users/autocomplete | 用户自动补全 |
| 用户API | users_id_get | GET /users/{id} | 用户详情 |
| 用户API | users_id_mute_delete | DELETE /users/{id}/mute | 取消静音用户 |
| 用户API | users_id_mute_post | POST /users/{id}/mute | 静音用户 |
| 用户API | users_id_projects_get | GET /users/{id}/projects | 用户项目 |
| 用户API | users_id_put | PUT /users/{id} | 更新用户 |
| 用户API | users_me_get | GET /users/me | 用户我 |
| 用户API | users_update_session_put | PUT /users/update_session | 用户更新会话 |
模型文档
- AutocompleteTaxon
- AutocompleteTaxonAllOf
- BaseResponse
- 颜色
- 评论
- 保护状况
- 核心地点
- 核心物种
- 日期详情
- 错误
- 设立方式
- 喜爱
- 字段值
- 识别
- 识别响应
- 识别响应全部
- 消息
- 消息响应
- 消息响应全部
- 附近地点响应
- 附近地点响应全部
- 附近地点响应全部结果
- 非业主识别
- 观察
- 观察分类
- 观察分类全部
- 观察者响应
- 观察者响应全部
- 观察者响应全部结果
- 观察响应
- 观察响应全部
- 观察显示响应
- 观察显示响应全部
- 照片
- 地点响应
- 地点响应全部
- 点GeoJson
- 多边形GeoJson
- 后注释
- 后注释注释
- 后评论
- 后评论评论
- 后标志
- 后标志标志
- 后识别
- 后识别识别
- 后消息
- 后消息消息
- 后观察
- 后观察字段值
- 后观察字段值观察字段值
- 后观察观察
- 后观察照片
- 后观察照片观察照片
- 后观察投票
- 后帖子
- 后帖子帖子
- 后项目添加
- 后项目观察
- 后质量
- 后用户
- 后用户更新会话
- 后用户用户
- 后投票
- 项目
- 项目成员
- 项目成员响应
- 项目成员响应全部
- 项目响应
- 项目响应全部
- 设置标志
- 设置标志标志
- 原始保护状态
- 显示观察
- 显示观察全部
- 显示地点
- 显示地点全部
- 显示分类
- 显示分类全部
- 声音
- 物种计数响应
- 物种计数响应全部
- 物种计数响应全部结果
- 分类自动完成响应
- 分类自动完成响应全部
- 分类显示响应
- 分类显示响应全部
- 分类保护状态
- 分类保护状态全部
- 分类照片
- 分类照片全部
- 更新项目观察
- 更新项目观察项目观察
- 用户
- 用户计数响应
- 用户计数响应全部
- 用户计数响应全部结果
- UtfGrid响应
要获取对crate生成的文档的访问权限，请使用
cargo doc --open
作者
依赖项
~4–15MB
~236K SLoC