{
    "openapi": "3.0.0",
    "info": {
        "title": "物流地址解析 - API文档",
        "version": "1.0.0",
        "description": "采用人工智能方法解析出文本中的收货人名称（人名、网名等）、联系方式、邮编和详细地址。并且可以将地址拆分出省市区（自治区、旗、盟等），极大方便电商和物流等行业项目应用。持续优化中，欢迎反馈问题。相关文章：<a target=\"_blank\" href=\"https:\/\/www.tianapi.com\/article\/149\">收货地址解析清洗接口小测试<\/a>"
    },
    "servers": [
        {
            "url": "https:\/\/apis.tianapi.com"
        }
    ],
    "paths": {
        "\/addressparse\/index": {
            "get": {
                "summary": "物流地址解析",
                "tags": [
                    "物流地址解析"
                ],
                "description": "解析字符串中的人名和格式化行政区划信息",
                "parameters": [
                    {
                        "name": "key",
                        "in": "query",
                        "description": "API密钥",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "description": "API密钥"
                        }
                    },
                    {
                        "name": "text",
                        "in": "query",
                        "description": "文本内容",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "example": "马云13800138000杭州市滨江区网商路699号",
                            "description": "文本内容"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功响应",
                        "content": {
                            "application\/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "city": {
                                            "type": "string",
                                            "example": "杭州市",
                                            "description": "城市"
                                        },
                                        "name": {
                                            "type": "string",
                                            "example": "马云",
                                            "description": "收货人姓名"
                                        },
                                        "detail": {
                                            "type": "string",
                                            "example": "浙江省杭州市滨江区网商路699号",
                                            "description": "完整地址"
                                        },
                                        "mobile": {
                                            "type": "string",
                                            "example": "13800138000",
                                            "description": "移动电话号码"
                                        },
                                        "district": {
                                            "type": "string",
                                            "example": "滨江区",
                                            "description": "区县"
                                        },
                                        "postcode": {
                                            "type": "string",
                                            "example": "310052",
                                            "description": "邮编（文本中优先否则默认区县级）"
                                        },
                                        "province": {
                                            "type": "string",
                                            "example": "浙江省",
                                            "description": "省\/特区\/自治区\/直辖市"
                                        }
                                    }
                                },
                                "example": {
                                    "msg": "success",
                                    "code": 200,
                                    "result": {
                                        "city": "杭州市",
                                        "name": "马云",
                                        "detail": "浙江省杭州市滨江区网商路699号",
                                        "mobile": "13800138000",
                                        "district": "滨江区",
                                        "postcode": "310052",
                                        "province": "浙江省"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "summary": "物流地址解析",
                "tags": [
                    "物流地址解析"
                ],
                "description": "解析字符串中的人名和格式化行政区划信息",
                "requestBody": {
                    "content": {
                        "application\/x-www-form-urlencoded": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "key": {
                                        "type": "string",
                                        "description": "API密钥"
                                    },
                                    "text": {
                                        "type": "string",
                                        "example": "马云13800138000杭州市滨江区网商路699号",
                                        "description": "文本内容"
                                    }
                                },
                                "required": [
                                    "key",
                                    "text"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "成功响应",
                        "content": {
                            "application\/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "city": {
                                            "type": "string",
                                            "example": "杭州市",
                                            "description": "城市"
                                        },
                                        "name": {
                                            "type": "string",
                                            "example": "马云",
                                            "description": "收货人姓名"
                                        },
                                        "detail": {
                                            "type": "string",
                                            "example": "浙江省杭州市滨江区网商路699号",
                                            "description": "完整地址"
                                        },
                                        "mobile": {
                                            "type": "string",
                                            "example": "13800138000",
                                            "description": "移动电话号码"
                                        },
                                        "district": {
                                            "type": "string",
                                            "example": "滨江区",
                                            "description": "区县"
                                        },
                                        "postcode": {
                                            "type": "string",
                                            "example": "310052",
                                            "description": "邮编（文本中优先否则默认区县级）"
                                        },
                                        "province": {
                                            "type": "string",
                                            "example": "浙江省",
                                            "description": "省\/特区\/自治区\/直辖市"
                                        }
                                    }
                                },
                                "example": {
                                    "msg": "success",
                                    "code": 200,
                                    "result": {
                                        "city": "杭州市",
                                        "name": "马云",
                                        "detail": "浙江省杭州市滨江区网商路699号",
                                        "mobile": "13800138000",
                                        "district": "滨江区",
                                        "postcode": "310052",
                                        "province": "浙江省"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}