Python3 访问 webservice 接口（request 方式）

清疚 2023-02-08 12:38 2阅读 0赞

### Python3 访问 webservice 接口（request 方式） ###

> 挣扎了两天时间，终于把 python 访问 webservice 需求给 处理好了  
> 这里只处理了 python 通过**request** 方式直接访问的方式，如果需要wsdl的方式请移步。

使用request 方式比较简单粗暴，虽然看网络上大家都推荐使用suds（后更名为 **suds-jurko**），研究了一天，只在官网看了各大概，鉴于之前的项目提供的本地的 WSDL 文件而没有在服务端直接配置，最后还是放弃了使用 WSDL 的方式，转而使用最简单粗暴的 **request** 方式。

如果 远程服务已经配置好了WSDL 文件，还是建议使用 **suds + wsdl** 的方式进行开发。

##### 1、首先要验证地址接口正常可用 #####

使用接口测试工具 postman 或者 直接在浏览器中直接验证，能正常返回数据信息 即为正常。  
我是使用 postman 验证

接口地址：参数是以 body 方式传入 xml 格式的参数呢人内容![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xvYmJ5X0Fubnk_size_16_color_FFFFFF_t_70_pic_center]  
认证类型：（不需要认证的请忽略）  
![在这里插入图片描述][20200930173004186.png_pic_center]  
我的参数内容如下：

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:sap_test:document:sap:soap:functions:mc-style">
       <soapenv:Header/>
       <soapenv:Body>
          <urn:ZcsfmGetEqui2k2>
             
             <PiInput>
                <Messageheader>
                
                   <Messageid>123456789110255</Messageid>
                   <Source>
                      <Sysname>TEST</Sysname>
                      <Bukrs>60</Bukrs>
                      <Werks>61</Werks>
                   </Source>
                   <Destination>
                      <Sysname>SAP</Sysname>
                      <Bukrs>60</Bukrs>
                      <Werks>61</Werks>
                   </Destination>
                   <Senddate></Senddate>
                   <Sendtime></Sendtime>
                </Messageheader>
                <Doc>
                   
                   <item>
                   
                      <Equnr></Equnr>
                       
                      <Sernr>C1</Sernr>
                      <Buffer1></Buffer1>
                      <Buffer2></Buffer2>
                      <Buffer3></Buffer3>
                      <Buffer4></Buffer4>
                      <Buffer5></Buffer5>
                      <Buffer6></Buffer6>
                      <Buffer7></Buffer7>
                      <Buffer8></Buffer8>
                      <Buffer9></Buffer9>
                      <Buffer10></Buffer10>
                   </item>
                </Doc>
             </PiInput>
          </urn:ZcsfmGetEqui2k2>
       </soapenv:Body>
    </soapenv:Envelope>

返回数据内容：如果结果没有数据，则没有 item 部分。

<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
        <soap-env:Header/>
        <soap-env:Body>
            <n0:ZcsfmGetEqui2k2Response xmlns:n0="urn:sap_TEST:document:sap:soap:functions:mc-style">
                <PiOutput>
                    <Messageid>123456789110255</Messageid>
                    <MsgType>S02</MsgType>
                    <MsgText/>
                    <Buffer1/>
                    <Buffer2/>
                    <Buffer3/>
                    <Buffer4/>
                    <Buffer5/>
                    <Buffer6/>
                    <Buffer7/>
                    <Buffer8/>
                    <Buffer9/>
                    <Buffer10/>
                    <Item>
                        <item>
                            <Equnr>000000000012903756</Equnr>
                            <Sernr>C1</Sernr>
                            <Eqart>CS1</Eqart>
                            <Eartx>设备</Eartx>
                            <Eqktx>设备'H35/40/45-05</Eqktx>
                            <Serge>H-05</Serge>
                            <Zzfleet>C</Zzfleet>
                            <Zzfleetx>客户车</Zzfleetx>
                            <Vkgrp>C001</Vkgrp>
                            <Spparnr>000474</Spparnr>
                            <Spname>客户公司</Spname>
                            <Shparnr>000474</Shparnr>
                            <Shname>客户公司</Shname>
                            <Hequi/>
                            <Hsernr/>
                            <Buffer1/>
                            <Buffer2/>
                            <Buffer3/>
                            <Buffer4/>
                            <Buffer5/>
                            <Buffer6/>
                            <Buffer7/>
                            <Buffer8/>
                            <Buffer9/>
                            <Buffer10/>
                            <Objnr>IE000000000012903756</Objnr>
                        </item>
                    </Item>
                </PiOutput>
            </n0:ZcsfmGetEqui2k2Response>
        </soap-env:Body>
    </soap-env:Envelope>

则测试结果能正常返回设备信息，下面就开始使用python 实现接口访问。

##### 2、直接贴代码 #####

我这是在python 服务 已存在的条件下增加新的功能，如果小伙伴你的python 服务还不能正常功能，建议你先搭建 完善的python 服务。

###### （1）引入依赖 ######

from pip._vendor.pyparsing import unicode # 中文编码处理工具
    import json
    
    from pyramid.view import view_config
    
    from utils import common_utils as utils # 自己的时间utils封装
    from pyramid.response import Response
    import requests
    from requests.auth import HTTPBasicAuth
    import xml.etree.ElementTree as et # xml 数据解析工具

###### （2） ######

接口名称

api_get = 'chain/asset_sap/{serial}/{device_id}'

headers

headers = {
        'content-type': 'text/xml'}

实现接口

@view_config(route_name=api_get,
                 renderer='json',
                 request_method='GET')
    def obtain_new_d(request):
        serial = request.matchdict.get('serial')
        device_id = request.matchdict.get('device_id')
        print(serial, device_id)
        device = obtain_by_serial(serial, device_id)
        # device = _obtain_by_serial(serial, device_id)
        return Response('{"res":' + json.dumps(device) + '}')

我觉得要注意一点，就是我使用 `"""params"""` ，符号创建的参数，使用 replace 替换内容无效果，因此，暂时拆分 之后作拼接

p1 = \
        """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:sap_TEST:document:sap:soap:functions:mc-style">
       <soapenv:Header/>
       <soapenv:Body>
          <urn:ZcsfmGetEqui2k2>
             
             <PiInput>
                <Messageheader>
                
                   <Messageid>"""
    p2 = \
        """</Messageid>
                   <Source>
                      <Sysname>TEST</Sysname>
                      <Bukrs>60</Bukrs>
                      <Werks>61</Werks>
                   </Source>
                   <Destination>
                      <Sysname>SAP</Sysname>
                      <Bukrs>60</Bukrs>
                      <Werks>61</Werks>
                   </Destination>
                   <Senddate></Senddate>
                   <Sendtime></Sendtime>
                </Messageheader>
                <Doc>
                   
                   <item>
                   
                      <Equnr>"""
    p3 = \
        """</Equnr>
                       
                      <Sernr>"""
    p4 = \
        """</Sernr>
                      <Buffer1></Buffer1>
                      <Buffer2></Buffer2>
                      <Buffer3></Buffer3>
                      <Buffer4></Buffer4>
                      <Buffer5></Buffer5>
                      <Buffer6></Buffer6>
                      <Buffer7></Buffer7>
                      <Buffer8></Buffer8>
                      <Buffer9></Buffer9>
                      <Buffer10></Buffer10>
                   </item>
                </Doc>
             </PiInput>
          </urn:ZcsfmGetEqui2k2>
       </soapenv:Body>
    </soapenv:Envelope>"""

sap 接口

sap_url_ = "http://cn***********/get_equi"

sap 接口请求实现

def obtain_by_serial(serial, device_id):
        device = {
        }
        try:
            param = p1 + str(utils.get_current_timestamp()) + p2  # 添加messageId
            if serial is not None and len(serial) > 0:
                param = param + p3 + serial + p4
            else:
                param = param + device_id + p3 + p4
            print(param)
            resp = requests.request("POST", sap_url_, headers=headers, data=param.encode(),
                                    auth=HTTPBasicAuth('your_username', 'your_password'))
            resp = unicode(resp.text)#我的结果会出现中文编码问题，如果没有这步可以不用
            tree = et.fromstring(resp)#xml 序列化
            #我的返回数据内容只有 最后的item内容是我的 设备信息，因此我用以下方式解析出我的设备信息并返回。具体方式视具体返回数据接口 而定
            for b in tree[1][0]:
                print(b.tag, b.text)
                for c in b:
                    print(c.tag, c.text)
                for d in b.iter('item'):
                    for e in d.iter('item'):
                        for f in e:
                            if f.text is None:
                                device[str(f.tag)] = ''
                            else:
                                device[str(f.tag)] = str(f.text)
            print(device)
            return device
        except Exception as e:
            print(e)
        return device

有需要的朋友也可以参考以下网址内容：

> 【1】xml 解析工具 elementTree [https://docs.python.org/3/library/xml.etree.elementtree.html][https_docs.python.org_3_library_xml.etree.elementtree.html]  
> 【2】requests 使用说明 [https://www.pluralsight.com/guides/web-scraping-with-request-python][https_www.pluralsight.com_guides_web-scraping-with-request-python]  
> 【3】suds 使用说明 [https://suds-py3.readthedocs.io/en/stable/][https_suds-py3.readthedocs.io_en_stable]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0xvYmJ5X0Fubnk_size_16_color_FFFFFF_t_70_pic_center]: /images/20230208/73f7b4e6c8444715a993390bb71277b4.png
[20200930173004186.png_pic_center]: /images/20230208/4a63988ffc85491daa026c38227c2aba.png
[https_docs.python.org_3_library_xml.etree.elementtree.html]: https://docs.python.org/3/library/xml.etree.elementtree.html
[https_www.pluralsight.com_guides_web-scraping-with-request-python]: https://www.pluralsight.com/guides/web-scraping-with-request-python
[https_suds-py3.readthedocs.io_en_stable]: https://suds-py3.readthedocs.io/en/stable/