Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bouke/lark
Swift SOAP Client
https://github.com/bouke/lark
lark soap swift swift-package-manager swift-soap-client
Last synced: 3 months ago
JSON representation
Swift SOAP Client
- Host: GitHub
- URL: https://github.com/bouke/lark
- Owner: Bouke
- License: other
- Archived: true
- Created: 2016-12-03T19:55:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-11-02T14:24:36.000Z (about 6 years ago)
- Last Synced: 2024-09-25T20:38:55.829Z (3 months ago)
- Topics: lark, soap, swift, swift-package-manager, swift-soap-client
- Language: Swift
- Homepage: http://boukehaarsma.nl/Lark/
- Size: 956 KB
- Stars: 53
- Watchers: 6
- Forks: 10
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Lark: Swift SOAP Client
=======================
Lark is a SOAP library written in Swift.
[](https://travis-ci.org/Bouke/Lark)
## Features
* [x] Swift 4
* [x] Swift Package Manager
* [x] API Client code generation
* [x] Strictly typed
* [x] SOAP 1.1
* [x] SOAP document/literal (wrapped) encoding
* [x] Both synchronous and asynchronous
## Communication
- If you **need help**, open an issue.
- If you'd like to **ask a general question**, open an issue.
- If you **found a bug**, open an issue.
- If you **have a feature request**, open an issue.
- If you **want to contribute**, submit a pull request.
## Usage
First, install the package by including the following in `Package.swift`:
```swift
.Package(url: "https://github.com/Bouke/Lark.git", majorVersion: 0)
```
Then, build your package. This will result in an executable named `lark-generate-client` which can generate the client code:
```sh
swift build
.build/debug/lark-generate-client "http://localhost:8000/?wsdl" > Sources/Client.swift
```
In your code you can now use the generated `Client` like this:
```swift
let client = HelloWorldServiceClient()
```
To call a remote method, inspect the generated functions on the Client. For example the `sayHello` method that takes a `SayHello` parameter and returns a `SayHelloResponse`:
```swift
let result = try client.sayHello(SayHello(name: "World", times: 2))
print(result.sayHelloResult)
```
Or if you're building a GUI that requires non-blocking networking, use the async version:
```swift
client.sayHelloAsync(SayHello(name: "World", times: 2)) { result in
print(result?.value.sayHelloResult)
}
```
More information can be found in the [documentation](http://boukehaarsma.nl/Lark).
## Example
See the [Lark-Example](https://github.com/Bouke/Lark-Example) repository for an
example of how to use Lark.
## Swift Compatibility
Swift 4 is required with version 1 of this package. Use version 0 if you need
Swift 3 compatibility.
## FAQ
### Is Linux supported?
Not yet. This library builds on various XMLDocument APIs that are either not available in Swift-Foundation (the Swift port of some Foundation APIs) or behave differently. Also a major dependency, AlamoFire, is not yet supported on iOS. To track the progress on this, subscribe to ticket [22](https://github.com/Bouke/Lark/issues/32).
### Is iOS supported?
No. This library builds on various XMLDocument APIs that are not available on iOS. Switching to another XML library might help here, but I don't have the need for this. Feel free to reach out to me if you're interested in working on a pull request to change this.
### Can it act as a SOAP server?
No. Feel free to reach out to me if you're interested in working on a pull request to change this.
### Is CocoaPods / Carthage supported?
No.
### Why is it called Lark?
SOAP is sometimes referred to as a fat messaging protocol. Swift is an elegant bird. A Lark sometimes looks like a fat bird.
## Credits
This library was written by [Bouke Haarsma](https://twitter.com/BoukeHaarsma).