https://github.com/servicestack/swiftref
Console App to add / update a Swift ServiceStack Reference
https://github.com/servicestack/swiftref
Last synced: 10 months ago
JSON representation
Console App to add / update a Swift ServiceStack Reference
- Host: GitHub
- URL: https://github.com/servicestack/swiftref
- Owner: ServiceStack
- Created: 2017-01-24T16:13:27.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-25T00:13:23.000Z (almost 9 years ago)
- Last Synced: 2025-03-09T22:07:07.777Z (10 months ago)
- Language: Swift
- Size: 43.9 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# swiftref
`swiftref` is an OSX command-line utility for quickly Adding or Updating a
[Swift ServiceStack Reference](http://docs.servicestack.net/swift-add-servicestack-reference)
for consuming Typed Web Services in a Swift v3 Xcode project.
## Install swiftref
The easiest way to install `swiftref` is to download the OSX binary and save it to your `/usr/local/bin`:
sudo curl https://raw.githubusercontent.com/ServiceStack/swiftref/master/dist/swiftref > /usr/local/bin/swiftref
sudo chmod +x /usr/local/bin/swiftref
## Usage
### Add a new ServiceStack Reference:
To Add a new ServiceStack Reference you just need to provide the Base URL for the remote ServiceStack Service
you wish to generate Typed Swift DTOs for:
swiftref {BaseUrl}
swiftref {BaseUrl} {FileName}
If the FileName is not provided it's inferred from the host name of the remote URL, e.g:
swiftref http://techstacks.io
Which will download the Typed Swift DTOs for [techstacks.io](http://techstacks.io) and save them to `techstacks.dtos.swift`
or if preferred, you can specify a different FileName to save to, e.g:
swiftref http://techstacks.io TechStacks
Which will save the Typed Swift DTOs to `TechStacks.dtos.swift`.
`swiftref` also downloads [ServiceStack's Swift Client](https://github.com/ServiceStack/ServiceStack.Swift)
and saves it to `JsonServiceClient.swift` which together with the Server DTOs contains all the dependencies required to
consume Typed Web Services in Swift.
### Update an existing ServiceStack Reference:
To Update an existing ServiceStack Reference provide its Filename as the first argument:
swiftref {FileName.dtos.swift}
As an example you can Update the Server DTOs added in the previous command with:
swiftref TechStacks.dtos.swift
This will also include any
[Customization Options](http://docs.servicestack.net/swift-add-servicestack-reference#swift-configuration)
that were manually added.
## Learn
To learn more, see Documentation for [Swift Add ServiceStack Reference](http://docs.servicestack.net/swift-add-servicestack-reference).