apipost導出文檔使用詳解

一、什麼是apipost導出文檔

apipost是一款在線介面管理工具，支持創建介面和介面文檔的管理。apipost導出文檔是指將創建好的介面文檔導出為特定格式的文件，例如HTML、PDF等，方便開發者進行分享和閱讀。apipost導出文檔能夠快速將原本繁瑣的API文檔自動化生成，並提高 API 文檔的可讀性和可維護性，大大提升開發者的工作效率。

二、如何導出apipost文檔

在apipost導出文檔功能中，有以下幾個步驟，可以快速地將介面文檔導出：

1.創建介面文檔

在apipost中，需要先創建介面文檔，介面文檔需要包含介面名稱、請求URL、請求方式、請求參數、請求結果等信息。在創建完成後，可以在”介面列表”中查看編輯好的文檔。

    
{
    "name": "示例介面",
    "protocol": "http",
    "host": "www.example.com",
    "path": "/api/example",
    "method": "GET",
    "headers": [
        {
            "key": "Content-Type",
            "value": "application/json"
        }
    ],
    "requestParams": [
        {
            "name": "name",
            "type": "string",
            "required": true,
            "defaultValue": "",
            "description": "用戶名"
        },
        {
            "name": "age",
            "type": "number",
            "required": true,
            "defaultValue": "",
            "description": "用戶年齡"
        }
    ],
    "responseParams": [
        {
            "name": "code",
            "type": "number",
            "description": "返回碼"
        },
        {
            "name": "message",
            "type": "string",
            "description": "返回信息"
        },
        {
            "name": "data",
            "type": "object",
            "description": "數據"
        }
    ],
    "description": "示例介面"
}
    

2.導出介面文檔

介面文檔創建完成後，點擊”導出”按鈕，彈出導出設置窗口，選擇需要導出的介面文檔類型，例如HTML、PDF等，並根據需求進行設置，選擇導出所需要的介面文檔信息，例如圖例、詳細參數、請求說明、響應說明等。最後點擊”導出”按鈕，即可將介面文檔導出為指定格式。

3.分享導出的介面文檔

導出介面文檔後，可以將其分享給團隊或客戶，方便他們查看和使用所提供的API，同時也能改善協同工作的效率，節省開發時間，提高產品質量。

三、apipost導出文檔的優點

1.快速創建介面文檔

使用apipost導出文檔功能，可以快速創建介面文檔，並且可以快速編輯、刪除和調整文檔信息，提高開發效率，減少開發成本。

2.提高API文檔的可讀性

apipost導出的介面文檔，根據不同的需求可以選擇導出不同的格式（例如HTML、PDF等），導出文檔具有良好的格式，清晰明了，具有較高的可讀性。同時，支持圖例、詳細參數、請求說明、響應說明等信息的導出，使得介面文檔更加具有可操作性、可維護性。

3.協作開發團隊

apipost支持多人協同操作，可以將具體任務指派給不同的團隊成員，實行高效的分工合作。而導出文檔可以被多人獲取，方便協調交流，更好地解決合作開發中出現的問題。

四、apipost導出文檔代碼示例

HTML格式導出

    
{
    "name": "示例介面",
    "protocol": "http",
    "host": "www.example.com",
    "path": "/api/example",
    "method": "GET",
    "headers": [
        {
            "key": "Content-Type",
            "value": "application/json"
        }
    ],
    "requestParams": [
        {
            "name": "name",
            "type": "string",
            "required": true,
            "defaultValue": "",
            "description": "用戶名"
        },
        {
            "name": "age",
            "type": "number",
            "required": true,
            "defaultValue": "",
            "description": "用戶年齡"
        }
    ],
    "responseParams": [
        {
            "name": "code",
            "type": "number",
            "description": "返回碼"
        },
        {
            "name": "message",
            "type": "string",
            "description": "返回信息"
        },
        {
            "name": "data",
            "type": "object",
            "description": "數據"
        }
    ],
    "description": "示例介面"
}
    

//導出HTML格式

    
POST /api/document/export HTTP/1.1
Host: localhost:8080
Content-Type: application/json;charset=UTF-8
Accept: application/json, text/plain, */*
X-Request-By: apipost/2.5.5
Cookie: apipost-language=zh;...
User-Agent: apipost/2.5.5  Node.js/v10.16.1

{
  "name": "示例介面",
  "actionType": "SWAGGER_TWO",
  "status": "SUCCESS",
  "description": "",
  "params": {
    "documentType": "HTML",
    "includeIntroduction": true,
    "includeRequestExample": true,
    "includeResponseExample": true,
    "includeRequestTable": true,
    "includeResponseTable": true,
    "includeRequestHeader": true,
    "includeResponseHeader": true,
    "includeMock": true,
    "includeDescription": true,
    "includeUpdateTime": true,
    "includeShare": true,
    "includeHierarchy": false,
    "includePostmanCollection": false,
    "includeParameterExample": false
  }
}
    

PDF格式導出

    
POST /boxapi/v1/http/document/export.pdf HTTP/1.1
Host: api.apipost.com
Content-Type: application/json;charset=UTF-8
Accept: application/json, text/plain, */*
Authorization: 
X-Request-By: apipost/2.5.5
User-Agent: apipost/2.5.5 Node.js/v10.16.1
Content-Length: 352
Connection: keep-alive

{
  "name": "示例介面",
  "actionType": "SWAGGER_TWO",
  "status": "SUCCESS",
  "description": "",
  "params": {
    "documentType": "PDF",
    "includeIntroduction": true,
    "includeRequestExample": true,
    "includeResponseExample": true,
    "includeRequestTable": true,
    "includeResponseTable": true,
    "includeRequestHeader": true,
    "includeResponseHeader": true,
    "includeMock": true,
    "includeDescription": true,
    "includeUpdateTime": true,
    "pageOrientation": "PORTRAIT",
    "pageSize": "A4",
    "marginTop": "20mm",
    "marginBottom": "20mm",
    "marginLeft": "20mm",
    "marginRight": "20mm"
  }
}