Yapi Render(v1.6.1+)

重要更新: 最新版本的插件已内嵌markdown渲染器，默认情况下无需任何额外配置即可正常使用。以下配置仅在您需要自定义渲染效果时才需要参考。

  • 目前yapi的open api更新接口并不会渲染接口备注信息, 如果接口备注信息中含有markdown内容, 需要配置markdown渲染器

  • 插件内置了一个简单的markdown渲染器, 如果对渲染效果不满意, 可以按照以下步骤配置自定义的markdown渲染器

markdown渲染器

注意: 由于插件已内嵌高质量的markdown渲染器，以下配置仅在您需要替换默认渲染器时才需要设置。大多数用户可以直接使用内嵌渲染器，无需任何额外配置。

渲染器目前分为两种, 一种是本地渲染器, 一种是远程渲染器

本地渲染器

有三条可用的配置规则:

  1. markdown.render.shell:渲染执行的shell, 插件将需要渲染的markdown暂存到临时目录, 将文件绝对路径作为参数追加到此shell后. 如果希望将绝对路径放在其他位置, 使用#fileName占位.
  2. markdown.render.work.dir: 执行渲染shell的工作文件夹
  3. markdown.render.timeout:渲染超时时间

配置示例:

markdown.render.shell=/usr/local/bin/node render.js
markdown.render.work.dir=/项目路径/yapi-markdown-render
markdown.render.timeout=3000

远程渲染器

只需要配置远程服务地址即可:

  1. markdown.render.server:远程服务地址, 这个地址接受POSTHTTP请求

配置示例:

markdown.render.server=http://localhost:3000/render

目前可用渲染器:

  1. node版markdown渲染器:yapi-markdown-render

目前提供的渲染服务

注意: 之前提供的渲染服务 http://www.itangcent.com/render 已经废弃，不再提供服务。请使用插件内嵌的渲染器或自行部署yapi-markdown-render。

  • 服务保证不以任何途径保存用户上传的内容,服务运行的代码始终与yapi-markdown-render主分支保持一致.
  • 不保证此服务长期稳定有效.请尽量自行部署yapi-markdown-render使用
  • 为防止服务被攻击/滥用,服务可能记录访问ip,亦有可能将异常ip加入黑名单.如有顾虑,请自行部署.
进阶使用
Call Api