Skip to content

Commit

Permalink
Adds godoc summary
Browse files Browse the repository at this point in the history
  • Loading branch information
c4milo committed Sep 3, 2014
1 parent 4c838c5 commit c49c05e
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*# WSDL to Go
Generates Go code from a WSDL file. This project is originally intended to generate Go clients for WS-* services.
### Features
* Supports only Document/Literal wrapped services, which are [WS-I](http://ws-i.org/) compliant
* Attempts to generate idiomatic Go code as much as possible
* Generates Go code in parallel: types, operations and soap proxy
* Supports:
* WSDL 1.1
* XML Schema 1.0
* SOAP 1.1
* Resolves external XML Schemas recursively, up to 5 recursions.
* Supports providing WSDL HTTP URL as well as a local WSDL file
### Not supported
* Setting SOAP headers
* SOAP 1.2 and HTTP port bindings
* WS-Security
### Usage
```
gowsdl [OPTIONS]
Application Options:
-v, --version Shows gowsdl version
-p, --package= Package under which code will be generated (myservice)
-o, --output= File where the generated code will be saved (myservice.go)
-i, --ignore-tls Ignores invalid TLS certificates. It is not recomended for production. Use at your own risk
(false)
Help Options:
-h, --help Show this help message
```
### TODO
* Add support for filters to allow the user to change the generated code
* If WSDL file is local, resolve external XML schemas locally too instead of failing due to not having a URL to download them from.
* Resolve XSD element references
* Support for generating namespaces
* Make code generation agnostic so generating code to other programming languages is feasible through plugins
## License
Copyright 2014 Cloudescape
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main

0 comments on commit c49c05e

Please sign in to comment.