如何招搖的API導出到郵遞員

Question

最近我寫了RESTful API中有用SpringMVC和招搖的UI（V2）。今天，我只注意到按鈕導入的postman.And我點擊它，我在上面剛纔看到的評論 「導入郵差收集，環境，數據轉儲，curl命令，或腎錯構瘤/ WADL /揚鞭（V1/V2）/ Runscope文件。」

起初我gooled，但沒有答案滿足我的情況。

所以我的問題是如何創建郵遞員需要的文件。順便說一下，我不熟悉招搖。

Answer 1

我使用PHP並使用Swagger 2.0來記錄API。 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": "jaydeep1012@gmail.com" 
     }, 
     "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": { 

    } 
} 

這可以導入到郵差如下。

1. 點擊在郵差UI的左上角的「導入」按鈕。
2. 您將看到多個選項來導入API文檔。點擊'粘貼原始文本'。
3. 將JSON格式粘貼到文本區域，然後單擊導入。
4. 你會看到所有的API爲'郵差收集'，並可以使用它從郵差。

您還可以使用 '導入來源鏈接'。這裏粘貼從Swagger或任何其他API文檔工具生成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; 

Answer 2

• 點擊橙色按鈕（ 「選擇文件」）
• 瀏覽到揚鞭DOC（swagger.yaml）
• 選擇文件之後，一個新的集合獲取郵差創建。它將包含基於您的端點的文件夾。

你也可以在線獲取一些示例swagger文件來驗證這一點（如果你在swagger doc中有錯誤）。