At the time of this writing I was using Go 1.11 and I've included versions of the libraries within the subdirectories. Perhaps you, oh mysterious future reader, no longer have these issues with later versions of Go or the libraries.
For work I need to get one of our Go services talking to Textkernel's (https://www.textkernel.com/) SOAP API and I wanted to document my struggles in a public location so I can refer back to this if I need to work with SOAP again.
This request (which was generated using https://github.com/hooklift/gowsdl) to TK fails (fileContent shortened for readability and credentials modified):
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<extract xmlns="http://home.textkernel.nl/sourcebox/soap/extract">
<account>account</account>
<username>username</username>
<password>password</password>
<fileName>Sample_IT_Resume_MartinL.pdf</fileName>
<fileContent>JVBERi0xLjU...</fileContent>
</extract>
</Body>
</Envelope>Where this request succeeds:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ext="http://home.textkernel.nl/sourcebox/soap/extract">
<soapenv:Header/>
<soapenv:Body>
<ext:extract>
<account>account</account>
<username>username</username>
<password>password</password>
<fileName>Sample_IT_Resume_MartinL.pdf</fileName>
<fileContent>JVBERi0xLjU...</fileContent>
</ext:extract>
</soapenv:Body>
</soapenv:Envelope>The issue is that the XML namespace prefixes
(https://www.w3schools.com/xml/xml_namespaces.asp) are not added on
the nodes: Envelope, Header, Body, and extract. If you google
"golang xml namespace prefix" you will see that Go does not have great
support for marshalling XML to have namespace prefixes. This was a
concise link I found describing a workaround:
https://forum.golangbridge.org/t/xml-namespace-prefix-issue-at-go/8055/2
In short, you need to have one struct for marshalling and one struct
for unmarshalling https://play.golang.org/p/qCbsCoQ0cHc That link also
linked to the namespace prefix issue on golang's github:
golang/go#13400
So it's not even a SOAP problem, its more of a XML problem and none of
the libraries I've tried namespace prefix ALL nodes Envelope,
Header, Body, extract. SIDE NOTE: According to this SOAP
documentation (https://www.w3schools.com/xml/xml_soap.asp) it sounds
like the "extract" does not need to have a prefix to satisfy the SOAP
protocol: "Immediate child elements of the SOAP Body element may be
namespace-qualified.". So I wonder why TK enforces "extract" to have a
namespace prefix.
At the time of this writing the client that has got me closest to
marshal things the way TK wants is: https://github.com/fiorix/wsdl2go
Run diff solutionsofar/extract/extract.go fiorixwsdl2go/extract/extract.go to see the changes I implemented to
make the generated code work for TK's "extract" operation.
Part my code changes were necessary but the others were me cleaning up code that is not needed (for example adding a XML tag on an embedded struct has no effect so I removed the code where fiorix did that).
In case of an error SOAP returns a Fault node with structured
information about what went wrong. Some libraries I encountered did
not unmarshal all of that information which lead to debugging trouble
so be wary of that.
fiorix does not even try to unmarshal the Fault node
(https://github.com/fiorix/wsdl2go/blob/69b96af60ac9b29848069ac8e6eed1d655496847/soap/client.go#L143)
which I am perfectly happy with because then we definitely capture all
information which could be useful when debugging. If at some point we
need to take programmatic action on certain errors then we can start
parsing it, but no need to worry about that until necessary.