#static-website #postman #collection #documentation #back-end #interactive #publish

bin+lib postport

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

1 个不稳定版本

0.1.1 2021 年 12 月 26 日

#18 in #postman

MIT 许可证

37KB
617 代码行

Postport

目前处于实验阶段

简介

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

静态网站

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

配置

config.yaml 可在此存储库的根目录中更改,以便通过 Postman API 获取远程 Postman 集合,例如:

获取您的 Postman API 密钥

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

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

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

Linux

路径

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

示例

/home/alice/.config/postport/config.yaml

MacOS

路径

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

示例

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

Windows

路径

{FOLDERID_RoamingAppData}\postport\config.yaml

示例

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

依赖关系

~6–22MB
~297K SLoC