如何在Readme.io文档中引用单个Swagger Schema实体?
解决方案:在Readme文档中引用Swagger单个Schema实体
目前Readme对Swagger的原生支持里,直接导入单个Schema实体并生成独立锚点链接的功能确实有限,但可以通过以下两种方式实现需求:
方法1:利用Readme的自定义Schema与锚点
- 从Swagger文档中复制目标Schema(比如
Address)的JSON/YAML定义 - 在Readme的对应端点参考页面添加一个自定义Schema块,将复制的定义粘贴进去
- 给这个Schema块设置自定义锚点:在块的编辑界面,找到「高级选项」设置锚点名称为
Address,这样就能生成https://<my_project>.readme.io/reference/<my_endpoint>#Address格式的直接链接 - 后续在文档其他位置需要引用时,直接使用这个锚点链接即可
方法2:通过Swagger文档预处理优化导入
- 使用工具(比如
swagger-cli或自定义脚本)拆分Swagger文档,将单个Schema实体提取为独立的组件文件 - 在Readme导入Swagger时,选择导入拆分后的组件,或者将提取的Schema单独关联到对应端点页面
- 导入后Readme会自动为每个Schema生成锚点,直接使用即可
注意:如果使用Readme的自动导入Swagger功能,默认只会在请求/响应体中展示Schema,不会生成独立的锚点链接。上述两种方法需要手动补充或预处理,但能满足你生成直接链接的需求。
内容的提问来源于stack exchange,提问作者Dima Dorogonov
相关产品推荐
相关产品推荐

