Backpub

目前处于实验阶段

简介

将 Postman 集合的后端文档作为具有交互式 API 的静态网站发布。

静态网站

使用 Svelte、TailwindCSS 和 Vite 生成网站，允许热重载，文件夹和请求应用了类，样式通过 app.css 文件 中的 Tailwind 指令进行控制。

配置

config.yaml 位于本存储库的根目录中，可以更改以允许通过 Postman API 获取远程 Postman 集合，例如。

获取您的 Postman API 密钥

通过点击其名称旁边的三个点并点击 设置 获取集合 ID

collection_from_api: true
postman_api_key: "XXXXX-XXXXX-XXXXX-XXXX"
collection_id: "XXXXXXX-XXXXXXXXX-XXXXXXXXX-XXXXXX"

您可以通过在配置文件夹中放置新文件来覆盖基本 config.yaml

Linux

路径

$XDG_CONFIG_HOME/backpub/config.yaml 或 $HOME/.config/backpub/config.yaml

示例

/home/alice/.config/backpub/config.yaml

MacOS

路径

$HOME/Library/Application Support/backpub/config.yaml

示例

/Users/Alice/Library/Application Support/backpub/config.yaml

Windows

路径

{FOLDERID_RoamingAppData}\backpub\config.yaml

示例

C:\Users\Alice\AppData\Roaming\backpub\config.yaml