[解決済み] Swagger APIをPostmanにインポートする方法は？

質問

最近、私はレストフルAPIを SpringMvc とswagger-ui(v2)を使っています。PostmanにImport機能があることに気づきました。

そこで質問なのですが、Postmanが必要とするファイルをどのように作成すればよいのでしょうか？

Swaggerに詳しくないのですが。

どのように解決するのですか？

私はPHPで仕事をしており、APIの文書化にSwagger 2.0を使用しています。 Swaggerドキュメントはオンザフライで作成されます（少なくとも私がPHPで使用しているものです）。ドキュメントはJSON形式で生成されます。

サンプル文書

{
    "swagger": "2.0",
    "info": {
    "title": "Company Admin Panel",
        "description": "Converting the Magento code into core PHP and RESTful APIs for increasing the performance of the website.",
        "contact": {
        "email": "[email protected]"
        },
        "version": "1.0.0"
    },
    "host": "localhost/cv_admin/api",
    "schemes": [
    "http"
],
    "paths": {
    "/getCustomerByEmail.php": {
        "post": {
            "summary": "List the details of customer by the email.",
                "consumes": [
                "string",
                "application/json",
                "application/x-www-form-urlencoded"
            ],
                "produces": [
                "application/json"
            ],
                "parameters": [
                    {
                        "name": "email",
                        "in": "body",
                        "description": "Customer email to ge the data",
                        "required": true,
                        "schema": {
                        "properties": {
                            "id": {
                                "properties": {
                                    "abc": {
                                        "properties": {
                                            "inner_abc": {
                                                "type": "number",
                                                    "default": 1,
                                                    "example": 123
                                                }
                                            },
                                            "type": "object"
                                        },
                                        "xyz": {
                                        "type": "string",
                                            "default": "xyz default value",
                                            "example": "xyz example value"
                                        }
                                    },
                                    "type": "object"
                                }
                            }
                        }
                    }
                ],
                "responses": {
                "200": {
                    "description": "Details of the customer"
                    },
                    "400": {
                    "description": "Email required"
                    },
                    "404": {
                    "description": "Customer does not exist"
                    },
                    "default": {
                    "description": "an \"unexpected\" error"
                    }
                }
            }
        },
        "/getCustomerById.php": {
        "get": {
            "summary": "List the details of customer by the ID",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "description": "Customer ID to get the data",
                        "required": true,
                        "type": "integer"
                    }
                ],
                "responses": {
                "200": {
                    "description": "Details of the customer"
                    },
                    "400": {
                    "description": "ID required"
                    },
                    "404": {
                    "description": "Customer does not exist"
                    },
                    "default": {
                    "description": "an \"unexpected\" error"
                    }
                }
            }
        },
        "/getShipmentById.php": {
        "get": {
            "summary": "List the details of shipment by the ID",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "description": "Shipment ID to get the data",
                        "required": true,
                        "type": "integer"
                    }
                ],
                "responses": {
                "200": {
                    "description": "Details of the shipment"
                    },
                    "404": {
                    "description": "Shipment does not exist"
                    },
                    "400": {
                    "description": "ID required"
                    },
                    "default": {
                    "description": "an \"unexpected\" error"
                    }
                }
            }
        }
    },
    "definitions": {

    }
}

これをPostmanに取り込むと、以下のようになります。

1. をクリックします。 インポート ' Postman UI の左上にあるボタンです。
2. API ドキュメントをインポートするための複数のオプションが表示されます。その中から' 生テキストを貼り付ける '.
3. テキストエリアにJSON形式を貼り付け、インポートをクリックします。
4. すべてのAPIが' ポストマンコレクション 'となり、Postmanから利用できるようになります。

また、「リンクからインポート」を使用することもできます。ここには、Swaggerやその他のAPI DocumentツールからAPIのJSON形式を生成するURLを貼り付けます。

これは私のドキュメント（JSON）生成ファイルです。これはPHPで作られています。JAVAはSwaggerと一緒で全くわかりません。

<?php
require("vendor/autoload.php");
$swagger = \Swagger\scan('path_of_the_directory_to_scan');
header('Content-Type: application/json');
echo $swagger;