打开终端。 输入以下命令安装Postman: sudo yum install -y postman 安装完成后打开Postman并使用账号登录。 二、 创建并完善接口集合 1. 选择左边目录的New">
Products
96SEO 2025-09-20 14:03 0
在CentOS系统上,先说说需要安装Postman应用。可以" src="/uploads/images/n2N4kS2S.webp"/>
sudo yum install -y postman
安装完成后打开Postman并使用账号登录。
1. 选择左边目录的New Collection,新建一个接口文件夹,建完后就会出现在左边的Collections目录下。
2. 在新建的接口文件夹中,点击“New Request”创建一个请求。
3. 在请求中填写接口的URL、请求方法、请求头和请求体等信息。
4. 选中集合中的每个请求, 切换至“Description” tab,补充以下信息:
若需要更专业的文档格式,可使用第三方工具docgen。
1. 安装docgen插件:
npm install -g docgen
2. 使用以下命令生成文档:
docgen /path/to/postman/collection.json /my/output/directory
其中, /path/to/postman/collection.json为Postman集合的JSON文件路径,/my/output/directory为生成的文档保存路径。
1. 使用以下代码生成Postman API文档的Java工具类:
package com.example; import net.sf.json.JSONArray; import net.sf.json.JSONObject; import java.io.*; import java.util.ArrayList; import java.util.List; public class ExportPostManApiUtil { public static String readToString { String encoding = "UTF-8"; File file = new File; StringBuilder sb = new StringBuilder; try , encoding))) { String line; while ) != null) { sb.append; } } catch { e.printStackTrace; } return sb.toString; } }
2. 运行以下代码生成文档:
public static void main { String jsonStr = ExportPostManApiUtil.readToString; JSONObject jsonObject = JSONObject.fromObject; JSONArray items = jsonObject.getJSONArray; for ; i++) { JSONObject item = items.getJSONObject; String name = item.getString; String description = item.getString; System.out.println; System.out.println; // ... 其他接口信息 } }
3. 运行上述代码后会在控制台输出接口名称、描述等信息,可用于生成文档。
公开链接,使得任何人都能查看该文档。
通过点击按钮,可以将文档导出为PDF、Word等格式,方便本地保存和分享。
本文介绍了如何将Postman在CentOS上的接口文档生成,包括准备工作、创建接口集合、使用第三方工具生成文档、生成并预览文档、发布文档供他人访问以及导出文档到本地等步骤。希望对您有所帮助。
Demand feedback