Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/almazrafi/swaggerkit
Swifty OpenAPI (Swagger) spec parser
https://github.com/almazrafi/swaggerkit
carthage cocoapods linux openapi spm swagger swift
Last synced: about 6 hours ago
JSON representation
Swifty OpenAPI (Swagger) spec parser
- Host: GitHub
- URL: https://github.com/almazrafi/swaggerkit
- Owner: almazrafi
- License: mit
- Created: 2020-02-26T07:26:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-25T03:25:31.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T13:35:22.819Z (18 days ago)
- Topics: carthage, cocoapods, linux, openapi, spm, swagger, swift
- Language: Swift
- Homepage:
- Size: 3.18 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwaggerKit
[](https://github.com/almazrafi/SwaggerKit/actions)
[](https://codecov.io/gh/almazrafi/SwaggerKit)
[](http://cocoapods.org/pods/SwaggerKit)
[](https://github.com/Carthage/Carthage)
[](https://swift.org/package-manager/)
[](https://developer.apple.com/xcode)
[](https://swift.org)
[](https://opensource.org/licenses/MIT)
SwaggerKit is a parser for [OpenAPI (Swagger)](https://swagger.io/specification) specs, completely written in Swift.
## Requirements
- iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+
- Xcode 10.3+
- Swift 5.0+
## Installation
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate SwaggerKit into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
platform :ios, '10.0'
use_frameworks!
target '' do
pod 'SwaggerKit', '~> 1.0.0-alpha.6'
end
```
Finally run the following command:
```bash
$ pod install
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate SwaggerKit into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "almazrafi/SwaggerKit"
```
Finally run `carthage update` to build the framework and drag the built `SwaggerKit.framework` into your Xcode project.
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.
To integrate SwaggerKit into your Xcode project using Swift Package Manager, add the following as a dependency to your `Package.swift`:
```swift
.package(url: "https://github.com/almazrafi/SwaggerKit.git", from: "1.0.0-alpha.6")
```
and then specify `"SwaggerKit"` as a dependency of the Target in which you wish to use SwaggerKit.
Here's an example `Package.swift`:
```swift
// swift-tools-version:5.0
import PackageDescription
let package = Package(
name: "MyPackage",
products: [
.library(name: "MyPackage", targets: ["MyPackage"])
],
dependencies: [
.package(url: "https://github.com/almazrafi/SwaggerKit.git", from: "1.0.0-alpha.6")
],
targets: [
.target(name: "MyPackage", dependencies: ["SwaggerKit"])
]
)
```
## Communication
- If you need help, 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.
## License
SwaggerKit is available under the MIT license. See the [LICENSE](LICENSE) file for more info.