apipost导出文档使用详解

一、什么是apipost导出文档

apipost是一款在线接口管理工具，支持创建接口和接口文档的管理。apipost导出文档是指将创建好的接口文档导出为特定格式的文件，例如HTML、PDF等，方便开发者进行分享和阅读。apipost导出文档能够快速将原本繁琐的API文档自动化生成，并提高 API 文档的可读性和可维护性，大大提升开发者的工作效率。

二、如何导出apipost文档

在apipost导出文档功能中，有以下几个步骤，可以快速地将接口文档导出：

三、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"
  }
}