Skip to content

Commit

Permalink
Change docs to godoc style instead of markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
maddyblue committed Jan 29, 2015
1 parent cc06d69 commit 38b2b37
Showing 1 changed file with 59 additions and 40 deletions.
99 changes: 59 additions & 40 deletions doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,50 +3,69 @@
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

/*
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
* WS-Addressing
* MTOM binary attachments
* UDDI
### Usage
```
gowsdl [OPTIONS]
Gowsdl generates Go code from a WSDL file.
This project is originally intended to generate Go clients for WS-* services.
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)
-v, --version
Shows gowsdl version
-p, --package=myservice
Package under which code will be generated
-o, --output=myservice.go
File where the generated code will be saved
-i, --ignore-tls
Ignores invalid TLS certificates. It is not recomended for production.
Use at your own risk.
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
-h, --help
Show this help message
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.
WS-Addressing.
MTOM binary attachments.
UDDI.
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.
*/
package main

0 comments on commit 38b2b37

Please sign in to comment.