Skip to content

Latest commit

 

History

History
92 lines (60 loc) · 3.21 KB

README.md

File metadata and controls

92 lines (60 loc) · 3.21 KB
Raw

Icon

Language Pod version

Start debugging iOS network calls like a wizard, without extra code! Wormholy makes debugging quick and reliable.

What you can do:

  • No code to write and no imports.
  • Record all app traffic that uses NSURLSession.
  • Reveal the content of all requests, responses, and headers simply by shaking your phone!
  • No headaches with SSL certificates on HTTPS calls.
  • Find, isolate and fix bugs quickly.
  • Swift & Objective-C compatibility.
  • Also works with external libraries like Alamofire & AFNetworking.
  • Ability to blacklist hosts from being recorded using the array ignoredHosts.
  • Ability to export API requests as Postman collection
  • Ability to share cURL rappresentation of API requests

Icon

Requirements

  • iOS 9.0+
  • Xcode 10+
  • Swift 4, 4.1, 4.2 and Swift 5

Usage

Add it to your project, and that's all! Shake your device or your simulator and Wormholy will appear! You don't need to import the library into your code, it works magically!

I suggest you install it only in debug mode. The easiest way is with CocoaPods:

pod 'Wormholy', :configurations => ['Debug']

If you want to disable the shake, and fire Wormholy from another point inside your app, you need to set the environment variable WORMHOLY_SHAKE_ENABLED = NO, and call this local notification:

NotificationCenter.default.post(name: NSNotification.Name(rawValue: "wormholy_fire"), object: nil)

You can also programmatically enable/disable the shake gesture at any time. You can do Wormholy.shakeEnabled = false to disable (or enable) the shake gesture.

Carthage

You can also install Wormholy using Carthage.

To integrate Wormholy into your Xcode project using Carthage, specify it in your Cartfile:

github "pmusolino/Wormholy"

Run carthage update to build the framework and drag the built Wormholy.framework into your Xcode project.

Contributing

  • If you need help or 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.

Acknowledgements

Made with ❤️ by Paolo Musolino.

Follow me on:

💼 Linkedin

🤖 Twitter

🌇 Instagram

👨🏼‍🎤 Facebook

MIT License

Wormholy is available under the MIT license. See the LICENSE file for more info.