postman导出api数据json文件使用php语言layui渲染到界面展示

原创 已于 2024-01-26 10:04:00 修改 · 439 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#postman #json #php

于 2023-05-24 14:31:47 首次发布

有个同事将API接口一直使用的postman来调试的，没有使用大家共用的api文档来写，造成api接口堆积越来越多。于是想到用php+layui读取postman的json文件，来展示出文档供前端开发人员使用。

开始

postman导出api数据json文件使用php语言layui渲染到界面展示

一个视图文件就可以搞定了

路由：

Route::get('/postman',function(){
    return  view('postman');
});

代码如下：

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>postman json api lumeng-(2023.05.24)</title>
    <meta name="renderer" content="webkit">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link href="//cdn.staticfile.org/layui/2.8.3/css/layui.css" rel="stylesheet">
</head>
<body class="layui-bg-gray">
<?php
use Illuminate\Http\Request;
$request = new Request();
$url_params = str_replace("/postman/?", "", $_SERVER['REQUEST_URI']);
parse_str($url_params, $url_params_ary);
$folder             = !empty($url_params_ary['folder']) ? $url_params_ary['folder'] : 'lumeng';
$json_name          = !empty($url_params_ary['json_name']) ? $url_params_ary['json_name'] : 'baidu';
$json_name_all      = $json_name.'.json';
$postman_path       =  base_path().'/resources/views/postman/';
$json_file_path     = "{$folder}/{$json_name_all}";
$json_folder_path   = $postman_path.$folder;
$get_file_path      = $postman_path.$json_file_path;
if(!file_exists($get_file_path))
{
    exit('文件不存在:'.$get_file_path);
}
        //echo $get_file_path;
$postman_api_str    = file_get_contents($get_file_path);
$postman_api_ary    = json_decode($postman_api_str, true);
//print_r($postman_api_ary);exit;
//所有目录
$file_lists_ary      = scandir($postman_path);
$folder_name_ary     = [];
foreach($file_lists_ary as $k=>$v){
    if($v=="." || $v==".."){continue;}
    $folder_name_ary[] = str_replace(".json", "", $v);
}

//所有json文件（该人员下的
$file_lists_ary      = scandir($json_folder_path);
$json_name_ary      = [];
foreach($file_lists_ary as $k=>$v){
    if($v=="." || $v==".."){continue;}
    $json_name_ary[] = str_replace(".json", "", $v);
}
//print_r($folder_ary);
//print_r($json_name_ary);exit;
$this_url = request()->url();
//echo $this_url;exit;
?>

<style>
    .layui-card-header{background:#fafafa; margin-top: 5px;   }
</style>



<ul class="layui-nav layui-bg-green" lay-bar="disabled">
    <li class="layui-nav-item">
        <a href="javascript:;">人员</a>
        <dl class="layui-nav-child">
            <?php
            foreach($folder_name_ary as $f_name):?>
            <dd><a href="<?php echo $this_url.'?folder='.$f_name.'&json_name=';?>"><?php echo $f_name;?></a></dd>
            <?php endforeach;?>
        </dl>
    </li>

    <?php foreach($json_name_ary as $f_name):?>
    <li class="layui-nav-item"><a href="<?php echo $this_url.'?folder='.$folder.'&json_name='.$f_name;?>"><?php echo $f_name;?></a></li>
    <?php endforeach;?>
</ul>
<br>




{{--左侧菜单 --}}
<div class="layui-panel" style="width: 23%; margin: 16px;float:left;">
    <ul class="layui-menu" id="demo-menu">

        <?php
        foreach($postman_api_ary['item'] as $key1=>$item_one):
            if(empty($item_one['item'])) continue;
        ?>

        <li class="layui-menu-item-group layui-menu-item-up" lay-options="{type: 'group'}">
            <div class="layui-menu-body-title">
                <?php echo "{$item_one['name']}";?> <i class="layui-icon layui-icon-up"></i>
            </div>
            <ul>



{{--2级和3级菜单 begin--}}
<?php
foreach($item_one['item'] as $key2=>$item_two):
    $item_three_list = !empty($item_two['item']) ? $item_two['item'] : [];
?>

    <?php if(empty($item_three_list))://只有2级菜单
    ?>
        <li lay-options="{id: '<?php echo $key1.'_'.$key2?>'}">
            <div class="layui-menu-body-title" id="<?php echo $key1.'_'.$key2?>"><?php echo "{$item_two['name']}";?></div>
        </li>
    <?php else://3级菜单 ?>
        <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: false}">
            <div class="layui-menu-body-title"><?php echo "{$item_two['name']}";?></div>
            <ul>

                <?php
                foreach($item_three_list as $key3=>$item_three):
                ?>
                <li lay-options="{id: '<?php echo $key1.'_'.$key2.'_'.$key3;?>'}">
                        <div class="layui-menu-body-title">
                            <?php echo "{$item_three['name']}";?></div></li>
                <?php endforeach;?>
            </ul>
        </li>
    <?php endif;?>
<?php endforeach;?>
{{--2级和3级菜单 endif--}}







            </ul>
        </li>

            <?php endforeach;?>
        <li class="layui-menu-item-divider"></li>


    </ul>
</div>





{{--右侧body--}}
<?php
foreach($postman_api_ary['item'] as $key_1=>$item_one):
if(empty($item_one['item'])) continue;
foreach($item_one['item'] as $key_2=>$item_two):

    if(empty($item_two['request']) && empty($item_two['item']))
    {
        continue;
    }
    $id_key     = 'rightbody_'.$key_1.'_'.$key_2;
    $item_three_list = !empty($item_two['item']) ? $item_two['item'] : [];
    if(empty($item_three_list))://只有2级菜单
            body_html($id_key, $item_two);
    else://3级菜单
        foreach($item_three_list as $key3=>$item_three):
            body_html($id_key.'_'.$key3, $item_three);
        endforeach;
    endif;
?>



<?php
endforeach;?>
<?php
endforeach;?>

<?php
function body_html_param($query_ary,$query_formdata=[])
{
    $html = '';
    //$query_ary =  !empty($item_two['request']['url']['query']) ? $item_two['request']['url']['query'] : [];
    foreach($query_ary as $query_row):
        $key    = $value = $description = '';
        if(!empty($query_row['key'])) $key= $query_row['key'];
        if(!empty($query_row['value'])) $value= $query_row['value'];
        if(!empty($query_row['description'])) $description= $query_row['description'];
        $html .='<tr>';
        $html .='<td>'.$key.'</td>';
        $html .='<td>'.$value.'</td>';
    $html .='<td>'.$description.'</td>';
    $html .='</tr>';
    endforeach;

    //$query_ary =  !empty($item_two['request']['body']['formdata']) ? $item_two['request']['body']['formdata'] : [];
    foreach($query_formdata as $query_row):
        $key    = $value = $description = '';
        if(!empty($query_row['key'])) $key= $query_row['key'];
        if(!empty($query_row['value'])) $value= $query_row['value'];
        if(!empty($query_row['description'])) $description= $query_row['description'];
        $html .='<tr>';
        $html .='<td>'.$key.'</td>';
        $html .='<td>'.$value.'</td>';
        $html .='<td>'.$description.'</td>';
        $html .='</tr>';
    endforeach;
    return $html;
}//end function

function body_html($id_key, $item_two){
    //method
    $method         = !empty($item_two['request']['method']) ? $item_two['request']['method'] : '';
    //接口路径
    $api_url        = '';
    if(!empty($item_two['request']['url']['raw']))
    {
        $api_url = $item_two['request']['url']['raw'];
    }else{
        if(!empty($item_two['request']['url']) && is_string($item_two['request']['url']))
        {
            $api_url = $item_two['request']['url'];
        }
    }
    //response
    $response = '';
    if(!empty($item_two['response'])){
    $response =@json_encode($item_two['response']);
    }

//param
$query_ary              =  !empty($item_two['request']['url']['query']) ? $item_two['request']['url']['query'] : [];
$query_formdata         =  !empty($item_two['request']['body']['formdata']) ? $item_two['request']['body']['formdata'] : [];
$body_html_param        = body_html_param($query_ary,$query_formdata);

    $a =  <<<EOF
<div id="{$id_key}" class="layui-body" style="width:75%; float: left;display: none;" >
    <div style="padding: 15px;">
        <div class="layui-card layui-panel">

            <blockquote class="layui-elem-quote layui-text">
                接口名称：{$item_two['name']}
</blockquote>

<div class="layui-card-header">
    method：
</div>
<div class="layui-card-body">
    {$method}
</div>


<div class="layui-card-header">
    接口路径:
</div>
<div class="layui-card-body">
    {$api_url}
</div>

<div class="layui-card-header">
    请求参数：
</div>

<div class="layui-card-body">

    <table class="layui-table">
        <colgroup>
            <col width="150">
            <col width="150">
            <col>
        </colgroup>
        <thead>
        <tr>
            <th>key</th>
            <th>value</th>
            <th>description</th>
        </tr>
        </thead>
        <tbody>
        $body_html_param

        </tbody>
    </table>
</div>


<div class="layui-card-header">
    response：
</div>
<div class="layui-card-body">
    {$response}
</div>

</div>
</div>
</div>

EOF;
    echo $a;
}
?>
{{--右侧body END--}}





<script src="//cdn.staticfile.org/layui/2.8.3/layui.js"></script>
<script src="//libs.baidu.com/jquery/2.0.0/jquery.min.js"></script>
<script>
    layui.use(function(){
        var dropdown = layui.dropdown;
        var layer = layui.layer;
        var util = layui.util;
        // 菜单点击事件
        dropdown.on('click(demo-menu)', function(options){
            console.log(this, options);
            var body_id = "#rightbody_"+options.id;
            $(".layui-body").hide();
            $(body_id).show();
            console.log(body_id);
            // 显示 - 仅用于演示
//            layer.msg(util.escape(JSON.stringify(options)));
        });
    });
</script>
</body>
</html>

结束

附git的下载地址：

https://gitee.com/onegua/lmapi2postman

lumengabc
关注
记录一次积木报表API数据集无法正常展示数据问题的排查全过程
jcj_gyjf的博客
08-06 7703
传参正常，接口数据返回正常。但积木报表无法正常展示数据。本地调试发现内部fastjson解析某个东西报错：com.alibaba.fastjson.JSONException: exepct '[', but EOF, pos 0, line 1, column 1
Postdown:从Postman生成Markdown API文档
05-23
发布后 从Postman生成markdown API文档。 安装 pip install postdown 用法 从邮递员导出JSON 从Postman导出您的收藏集（目前仅支持到Collection v2）。 您可以获取一个JSON文件。 第一步：选择您要导出的收藏集。 第二步：找到导入按钮，然后单击它。 第三步：将您的收藏导出为collection v2 。 运行postdown生成markdown文档： postdown xxx.json xxx.md 然后，您将获得降价格式的API文档。
文档的基本操作.postman_collection.json
02-27
ES文档的基本操作API- postman导出数据
Postman导出JSON文件轻松转换为HTML或Markdown
NHB66666666的博客
12-13 962
然而，有时候为了更直观地向团队成员展示接口信息，即文档化，我们可能需要将这些JSON数据转换为更易于阅读的格式，如。这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！是一种轻量级的标记语言，它允许你使用简单的文本格式来编写文档，这些文档可以被转换为结构化的。格式的文件，从易读性和直观性来讲，不是很方便，如果别人想看你的接口信息，只能将。格式的文件，从而更方便地分享和展示。
Postman导出Api文档
西京刀客
08-11 2万+
Postman导出Api文档 新建接口文件夹 1.选择左边目录的New Collection，新建一个接口文件夹，建完后就会出现在左边的Collections的目录下 新建的接口存到文件夹里，这样才可以把接口管理起来，一起导出来 把接口文件夹里的接口整体导出 1.打开postman,然后找到自己的接口文件夹，鼠标移上去，点击右边的三个点，选择export即可 导出后会在指定的文件目录下生成一个.json的文件。 参考 Postman如何导出接口，学会这招后台开发再交接工作时，保准不被喷！ 参考URL: ht
postman、apipost接口导出成json
weixin_52236586的博客
10-23 1828
如何把postman得到的数据存成json文件，然后放到vue中使用
12-17
在Postman中获取到数据后将其保存为JSON文件通常包含以下几个步骤： 1. **获取数据**：首先，在Postman中运行请求并获取需要的数据。可以将返回的结果设置为`raw`格式或复制到剪贴板。 2. **保存为JSON**： - ...
下载文件流太大，导致使用postman调导出卡死
最新发布
10-28
首先，用户的问题是：“如何使用Postman调用导出接口时因下载文件流太大导致卡死的问题？”意思是调用导出接口时，下载的大文件导致Postman卡死。 我需要参考系统指令： - 所有行内数学表达式必须使用$...$格式。 -...
Postman Chrome插件开发与使用详解
而 JSON 作为当今最主流的数据格式，Postman 不仅支持其解析与渲染，还允许用户在脚本中使用内置的 JSON 解析器进行数据提取和验证。 综上所述，“Postman - Chrome插件”不仅是一个历史产品形态，更代表了一种高效...
JSON转换工具：便捷的JsonView转换器
例如，在Chrome浏览器中安装JsonView插件后，当服务器返回application/json类型的响应时，浏览器会自动调用JsonView对原始JSON文本进行渲染，展示为树状结构，用户可点击展开某个字段，快速定位所需信息。...
docodile：从Postman集合生成HTML API文档
02-04
十二指肠 从Postman集合生成HTML API文档 目前的代码很糟糕 用法 别忘了先运行composer install ./docodile generate /path/to/postman/collection.json /my/output/directory 如果/my/output/directory已经存在，则该过程将退出，因为继续将完全删除该目录。 --force将强制删除 --url：为url添加选项。 例如“ ” 主题化 Docodile现在支持从bootswatch（ ）和Highlightjs捆绑样式（ ）切换主题 例如： ./docodile gener
postman 文档、导出json脚本 导出响应数据 response ，showdoc导入postman json脚本 导出为文档word或markdown
test
06-24 1万+
如果存在同名项目，会提示替换 或 拷贝导入：导入成功。直接 Export ：导出json脚本。
postman怎么提取json数据
南城猿的博客
05-06 9140
postman怎么提取json数据
postman将接口返回结果生成json文件到本地
努力努力再努力的小笼包
07-26 6449
postman中将接口返回数据生成json文件
postman的学习——如何将脚本导出成json文件
sun_977759的博客
07-27 2万+
将所有测试接口写到一个集合里面 点击集合后面的···，选择export 选择推荐的那个版本，点击export确定导出 选择要导出到的文件目录，点击保存，即可得到一个接口脚本的json文件 点击环境管理，选择导出具体的环境变量，即可得到一个环境变量的json文件 点击globals，进入到全局变量编辑窗口，点击下方的download as json，即可得到一个全局变量的json文件 得到这几个文件后，即可通过newman在命令行执行接口测试脚本了newman的基本使用 另外，也.
postman如何测试php接口_基于Postman的API自动化测试
weixin_39940154的博客
12-20 300
基于Postman的API自动化测试1、安装两种安装方式，我热衷于以chrome插件形式安装Chrome插件Mac App2、发送请求Postman最基础的功能就是发送http请求，支持GET/PUT/POST/DELETE，还有很多我不认识的http方法。通过填写URL、header、body等就可以发送一个请求，这对于我们平时做一些简单的测试是够用的。如果你的应用需要用到登录验证，可以通过填写...
postman导入json格式的接口文档
热门推荐
zengliguang的专栏
06-21 2万+
点击下载，等待下载完成即可。
Postman 发送json格式请求
resilient的博客
04-27 3576
1.content-type:application/json 2.选row 3.传入json格式数据 { "cartStr":"CH6003748|1", "request_tag":"trs" } postman 相关下载地址:
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值