将 API 方法/调用包含在生成的文档中
作者: mffap创建于 2023年5月25日更新于 2026年9月17日
标签area/docsservice-layerTo-be-closed
后续行动:https://GitHub.com/zitadel/zitadel/issues/5825
作为开发者/用户,我想能够在我们的文件中搜索 REST/GRPC 的电话,以便我能找到并读取相应电话的文件。
为什么今天不起作用?
- API文件自动生成,我们使用https://GitHub.com/PaloAltoNetworks/docusaurus-openapi-docs
- 最终标记降值直接来自插件
- 没有任何明显的方法可以让我从文件页上以一致的方式爬出其余的呼叫(方法+资源路径)以及RPC
[任务列表]
- 接受标准
- [ ]决定:在描述和生成中自动包括呼叫?
- REST 方法和资源路径可在文件页上查阅(要么作为内容的一部分,要么用一个独特的 cs 类标记)
- [ ]RPC可在文件页上查阅(或作为内容的一部分,或用独特的css类标记)
内容来源: zitadel/zitadel