2 个不稳定版本
0.12.1 | 2024年7月7日 |
---|---|
0.11.0 | 2022年7月31日 |
#315 in 网页编程
138 每月下载量
160KB
2K SLoC
p7m-appointment 的 Rust API 客户端
与预约相关数据的 API
这是 P7M 服务中用于管理和预约计划的 API。它通过具有公共功能且不需要用户身份验证的预订小部件(见 WidgetApi 标签)使用。
对于其他标签中的端点,调用者必须通过系统进行身份验证,并在 HTTP 请求的授权头中提供 JWT 令牌。使用 API 时,您通常通过首先使用 OAuth 2.0 进行身份验证来获取此令牌。
当您使用 Swagger 界面尝试此 API 时,需要点击 Authorize
按钮,然后在弹出的窗口中再次点击 Authorize 按钮。
概览
此 API 客户端由 OpenAPI Generator 项目生成。通过使用远程服务器上的 openapi-spec,您可以轻松生成 API 客户端。
- API 版本:0.12.1
- 包版本:0.12.1
- 构建包:
org.openapitools.codegen.languages.RustClientCodegen
安装
将包放入名为 p7m-appointment
的目录下,并将以下内容添加到 Cargo.toml
中的 [dependencies]
p7m-appointment = { path = "./p7m-appointment" }
API 端点文档
所有 URI 都是相对于 https://book.p7m.de/v1
类 | 方法 | HTTP 请求 | 描述 |
---|---|---|---|
AvailabilityApi | delete_availability_by_id | DELETE /availabilities/{id} | 删除可用性 |
AvailabilityApi | get_availabilities | GET /availabilities | 获取可用性列表 |
AvailabilityApi | get_availability_by_id | GET /availabilities/{id} | 请求单个可用性 |
AvailabilityApi | post_availabilities | POST /availabilities | 创建新的可用性时间段 |
AvailabilityApi | put_availability_by_id | PUT /availabilities/{id} | 更新单个可用性 |
BookingTenantApi | delete_booking_tenant_by_id | DELETE /booking/tenant/{id} | 按 ID 删除预订租户 |
BookingTenantApi | get_booking_tenant_by_id | GET /booking/tenant/{id} | 根据其 ID 获取(预订)租户 |
BookingTenantApi | get_booking_tenants | GET /booking/tenant | 获取预订租户列表 |
BookingTenantApi | post_booking_tenant | POST /booking/tenant | 创建一个新的预订租户 |
BookingTenantApi | put_booking_tenant_by_id | PUT /booking/tenant/{id} | 更新现有的预订租户 |
HolidayApi | get_holidays | GET /holidays | 获取系统已知的公共假期列表 |
ReservationApi | delete_reservation_by_id | DELETE /reservations/{id} | 删除具有给定ID的预订 |
ReservationApi | get_reservations | GET /reservations | 获取所有预订 |
ReservationApi | get_reservations_by_id | GET /reservations/{id} | 获取通过其ID标识的单个预订 |
ReservationApi | post_reservations | POST /reservations | 创建一个新的预订 |
ReservationApi | put_reservation_by_id | PUT /reservations/{id} | 更新现有的预订 |
ReservationApi | put_reservation_tags_by_id | PUT /reservations/{id}/tags | 更新指定预订的标签(仅限标签) |
ServiceApi | delete_service_by_id | DELETE /services/{id} | 通过其ID删除服务 |
ServiceApi | get_service_by_id | GET /services/{id} | 通过其ID获取服务 |
ServiceApi | get_services | GET /services | 获取所有服务的列表 |
ServiceApi | post_service | POST /services | 创建一个新的服务 |
ServiceApi | put_service_by_id | PUT /services/{id} | 更新单个服务 |
TagApi | delete_tag_by_id | DELETE /tags/{id} | 通过ID删除标签 |
TagApi | get_tag_by_id | GET /tags/{id} | 通过其ID获取单个标签 |
TagApi | get_tags | GET /tags | 获取所有标签 |
TagApi | post_tag | POST /tags | 创建一个新的标签 |
TagApi | put_tag_by_id | PUT /tags/{id} | 更新现有的标签 |
WidgetApiApi | get_booking_config | GET /booking/config/{id} | 获取指定租户小部件的基本配置信息 |
WidgetApiApi | get_booking_schedule | GET /booking/schedule/{tid}/{sid}/{wid}/{date} | 获取可以预订服务的可用时间 |
WidgetApiApi | post_booking_reserve | POST /booking/reserve | 为用户预订时间槽 |
WidgetApiApi | post_booking_reserve_confirmation | POST /booking/reserve/{rid}/confirmation | 使用发送给用户的PIN确认预订 |
WidgetApiApi | put_booking_reserve_by_id | PUT /booking/reserve/{rid} | 重新发送现有预订的代码 |
WorkerApi | delete_worker_by_id | DELETE /workers/{id} | 通过其ID删除工人 |
WorkerApi | get_worker_by_id | GET /workers/{id} | 通过其ID获取单个工人 |
WorkerApi | get_workers | GET /workers | 获取所有工人的列表 |
WorkerApi | post_worker | POST /workers | 创建一个新的工人 |
WorkerApi | put_worker_by_id | PUT /workers/{id} | 更新现有的工人 |
模型文档说明
- AnswerOption
- Availabilities
- Availability
- AvailabilityData
- BookingTenant
- BookingTenantData
- ConfirmationRequest
- ConfirmationResponse
- DayOfWeek
- ExtraQuestion
- Holiday
- HolidayData
- Medium
- NewAvailability
- NewReservation
- NewService
- NewTag
- NewWorker
- Reservation
- ReservationData
- ReservationLimit
- ReservationRequest
- ReservationResponse
- ReservationType
- Service
- ServiceData
- SourceMedium
- Tag
- TagData
- TenantConfig
- Worker
- WorkerConfig
- WorkerData
要获取crate生成的文档,请使用
cargo doc --open
作者
依赖关系
~4–15MB
~229K SLoC