Skip to content

Commit c49c05e

Browse files
committed
Adds godoc summary
1 parent 4c838c5 commit c49c05e

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

doc.go

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*# WSDL to Go
2+
Generates Go code from a WSDL file. This project is originally intended to generate Go clients for WS-* services.
3+
4+
### Features
5+
* Supports only Document/Literal wrapped services, which are [WS-I](http://ws-i.org/) compliant
6+
* Attempts to generate idiomatic Go code as much as possible
7+
* Generates Go code in parallel: types, operations and soap proxy
8+
* Supports:
9+
* WSDL 1.1
10+
* XML Schema 1.0
11+
* SOAP 1.1
12+
* Resolves external XML Schemas recursively, up to 5 recursions.
13+
* Supports providing WSDL HTTP URL as well as a local WSDL file
14+
15+
### Not supported
16+
* Setting SOAP headers
17+
* SOAP 1.2 and HTTP port bindings
18+
* WS-Security
19+
20+
### Usage
21+
```
22+
gowsdl [OPTIONS]
23+
24+
Application Options:
25+
-v, --version Shows gowsdl version
26+
-p, --package= Package under which code will be generated (myservice)
27+
-o, --output= File where the generated code will be saved (myservice.go)
28+
-i, --ignore-tls Ignores invalid TLS certificates. It is not recomended for production. Use at your own risk
29+
(false)
30+
31+
Help Options:
32+
-h, --help Show this help message
33+
```
34+
35+
### TODO
36+
* Add support for filters to allow the user to change the generated code
37+
* If WSDL file is local, resolve external XML schemas locally too instead of failing due to not having a URL to download them from.
38+
* Resolve XSD element references
39+
* Support for generating namespaces
40+
* Make code generation agnostic so generating code to other programming languages is feasible through plugins
41+
42+
43+
## License
44+
Copyright 2014 Cloudescape
45+
46+
Licensed under the Apache License, Version 2.0 (the "License");
47+
you may not use this file except in compliance with the License.
48+
You may obtain a copy of the License at
49+
50+
http://www.apache.org/licenses/LICENSE-2.0
51+
52+
Unless required by applicable law or agreed to in writing, software
53+
distributed under the License is distributed on an "AS IS" BASIS,
54+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
55+
See the License for the specific language governing permissions and
56+
limitations under the License.
57+
*/
58+
package main

0 commit comments

Comments
 (0)