SDK Polish and Fixes

[dtolb]

We're looking at the shape of our SDKs and seeing if they justify a re-write, or just need better docs, or something else.

Please make some suggestions for the PHP SDK. I'm open to pretty much everything.

• Do you have any PHP SDKs that were awesome to use and Bandwidth should implement some of those design patterns?
• Do you have any small gripes with the SDK now that Bandwidth should fix?
• Any big gripes with the SDK as is now?
• Do you even want an SDK? I mean it's just HTTP requests 😉 (j.k.)
• Thoughts on Swagger generated SDKs? ALPHA SWAGGER DOCS

Thanks for your feedback. If you want to hit me up directly feel free (dtolb @ bandwidth.com)

[soundslocke]

Awesome, glad this is all being addressed! Supporting Composer and auto-loading is the main desire. You've already got that part and it's even better now that there's a proper tag + release in place :)

I'm not sure a total rewrite is in order but I do see room for refactoring.

A nice somewhat-related library that I've analyzed before is the Google API client: https://github.com/google/google-api-php-client

Many of their patterns could/would apply with your library as well.

The Guzzle library is also well built but their patterns or structure probably isn't as analogous: https://github.com/guzzle/guzzle

[shaneneuerburg]

Great documentation trumps all when it comes to getting developers to use a library. Stripe nails this: https://stripe.com/docs/api

If you were to put together documentation like theirs, I would be overjoyed. :)

[dtolb]

Sweet thanks guys! Getting this is on my to-do list. Have you seen slate ? I've been eyeing that.

As far as JUST PHP docs, anything that has blown you away?

[shaneneuerburg]

Slate would be great.

99% of just PHP library docs are horrendous. Guzzle's is decent. Since Bandwidth provides multiple language SDKs, it'd make more sense to do something like Slate rather than having a bunch of different documentation to maintain. Each language SDK should support all of the same functions as any other language, so it should work well.

[dtolb]

@shaneneuerburg @soundslocke

I've started development on a new version following Dropbox and Stripe's SDK.

You can track progress on the v2-preview branch

In the mean time, I've generated some documentation for the current site.

Also we're working on a complete overhaul of our doc site. Check that out at https://bw.api-docs.io/1.0

[soundslocke]

@dtolb Exciting to see this underway!