Skip to content

chore(doc): Add info about yukid RESTful API #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
knight42 merged 1 commit into from
Aug 19, 2025
Merged

chore(doc): Add info about yukid RESTful API #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions cmd/yukid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,3 +165,9 @@ envs:
}
}
```

### RESTful API

yukid 提供的 API 参考 [`registerAPIs` 函数](../../pkg/server/main.go) 的实现。其中 `/api/v1/metas` 和 `/api/v1/metas/{name}` 是可公开访问的，可以用于搭建状态页。

yukictl 也会使用这些 API 来操作 yukid。