zero-ppanel/apps/api/desc/common.api
shanshanzhong 9dacd85a89
Some checks failed
Build docker and publish / prepare (push) Has been cancelled
Build docker and publish / build (map[dockerfile:deploy/Dockerfile.admin image_name:ppanel-admin name:admin]) (push) Has been cancelled
Build docker and publish / build (map[dockerfile:deploy/Dockerfile.api image_name:ppanel-api name:api]) (push) Has been cancelled
Build docker and publish / build (map[dockerfile:deploy/Dockerfile.node image_name:ppanel-node name:node]) (push) Has been cancelled
Build docker and publish / build (map[dockerfile:deploy/Dockerfile.queue image_name:ppanel-queue name:queue]) (push) Has been cancelled
Build docker and publish / build (map[dockerfile:deploy/Dockerfile.scheduler image_name:ppanel-scheduler name:scheduler]) (push) Has been cancelled
Build docker and publish / deploy (push) Has been cancelled
Build docker and publish / notify (push) Has been cancelled
初始化
2026-02-26 04:12:43 -08:00

39 lines
857 B
Plaintext

syntax = "v1"
info (
title: "公共接口"
)
@server (
prefix: /api/v1
group: common
)
service ppanel-api {
@handler HealthHandler
get /health returns (HealthResp)
@handler GetGlobalConfigHandler
get /config returns (GlobalConfigResp)
@handler SendEmailCodeHandler
post /send_email_code (SendEmailCodeReq)
@handler GetAnnouncementListHandler
get /announcement returns ([]AnnouncementResp)
@handler GetDocumentListHandler
get /document returns ([]DocumentListResp)
@handler GetDocumentDetailHandler
get /document/:id (DocumentDetailReq) returns (DocumentDetailResp)
@handler GetAvailablePaymentMethodsHandler
get /payment/methods returns ([]PaymentMethodResp)
@handler GetSubscribeGroupListHandler
get /subscribe/group returns ([]SubscribeGroupResp)
@handler GetSubscribeListHandler
get /subscribe returns ([]SubscribeResp)
}