Box API Navigator

An interactive tool for learning the Box API

Reviews

Discussion

You need to become a Contributor to join the discussion - Find out how.
Mike Schwartz
Maker
@_mikeschwartz · Platform at Box
Hey Product Hunters - we're really excited to share this new tool! Box’s API provides a number of different capabilities to handle files in an application. From uploading a file to displaying a file to searching for files, different endpoints of our API can be chained together to power a file component of any application. But sometimes, it can be hard to understand how these different endpoints fit together and how they might help you in an application you’re building. Today, we're excited to introduce a new tool for developers called API Navigator. API Navigator is a web application that allows you to explore how Box Platform can be integrated into an application using our APIs. You can read an introduction to API Navigator here: https://docs.box.com/v2.0/blog/i... We've also made a ton of updates to our developer experience and you can read more about this here: https://blog.box.com/blog/box-de... Let me know if you have any questions!
Ilya M@matveyich · Product manager of tech products
@_mikeschwartz top level dev-experience Just wonder if you have a dedicated team for that product Keep it up!
Mike Schwartz
Maker
@_mikeschwartz · Platform at Box
@matveyich we do! We have a whole team that solely focuses on developer tools. API Navigator was built by a team at Box who builds demos for customers. We've now productized this and will continue to look at how to improve it - maybe even open source it.
Mike Schwartz
Maker
@_mikeschwartz · Platform at Box
A lot of folks have been mentioning the move from static to interactive documentation. We recently enabled a bunch of new features to our docs, created by our documentation platform, Readme.io. If you haven't heard of Readme, check them out. You can also explore our new docs site here: https://docs.box.com
Nicolas Grenié@picsoung · Developer Evangelist, 3scale.net
Well done Box API team! :) This is a new example on developer experience. Stripe is taking a similar path with integrating Runkit (https://runkit.com) examples in their API documentation. After static documentation came interactive documentation generated by API description format like Swagger or RAML. We also had companies like Readme.io trying to provide a "standard" layout for API documentation. I think now it's the time for interactive/dynamic examples like this one. But I really wonder how this tool could be maintain in the back, is it easy to add a new feature/endpoint? Are you using anything like Swagger? Plan to opensource your tool?
Mike Schwartz
Maker
@_mikeschwartz · Platform at Box
@picsoung hey Nicolas- great questions. We're looking into a swagger spec now and have a really good relationship with Readme.io, so perhaps we can work with them by defining a standard for API Navigators. As I mentioned in the comment above, this was an internal tool developed by a few folks at Box that we decided to open up. The feedback has been really positive so far!
Alvaro Pereyra@yaraher · CEO of CodePicnic
@picsoung Not *that* related (sadly :) ) but I think that what you mention is what we're trying to accomplish at CodePicnic (https://codepicnic.com/docs) to move from static documentation towards real code users can actually work with, play around (and obviously, mess up!).
Naomi Assaraf@nassaraf · CMO, Technophile, pancake lover.
My Dev team will love this. 😊
Mike Schwartz
Maker
@_mikeschwartz · Platform at Box
@nassaraf awesome! We'd love to help in any way we can.
Ted Blosser@ted_blosser · Founder, WorkRamp
awesome upgrade!! Can't wait to use it to test our Box APIs much more quickly.
Mike Schwartz
Maker
@_mikeschwartz · Platform at Box
@ted_blosser thanks for the comment, Ted! You should check out our docs, too. The folks at Readme.io have introduced a ton of new features! Thanks for setting us up with them!
Ted Blosser@ted_blosser · Founder, WorkRamp
@_mikeschwartz @gkoberger has the best product on the market! Glad to know that Box is truly taking a developer-first approach in everything it builds.
Patrick Poulin@patrick_poulin · CEO @ API Fortress
@ted_blosser @_mikeschwartz @gkoberger One more ping for the team at Readme. @gkoberger is always helpful and generous with his time!
Sanjay Padval
Maker
@sanjay_padval · Product Manager @Facebook
Alain Ekambi@ekambos · Founder @ahomeit
Nice. Only thing is why would a documentation require access to my Google Account ? :)
Austin Ringer@deleted-803803
@ekambos Hey Alain, thanks for checking out the tool! I helped out with this project. We added Google as an authentication option for convenience. Our thought here was that some developers that visit the site for the first time may not have a Box account just yet. You can certainly log in to API Navigator with Box if that is preferred!
Alain Ekambi@ekambos · Founder @ahomeit
@austinringer Actually I was thinking just being able to check out/playing with the docs without even needing to register/login. M I missing something or why is login in required ?
Austin Ringer@deleted-803803
@ekambos Our hope in adding authentication is to allow API Navigator users to save their changes (uploaded files, meatdata, events, and so on). To be transparent, we also like to have an idea of who is using the tool. This helps us better understand Box's growing developer community :-) I totally see your where you are coming from, though. Perhaps we can change this in the future! For the time being, Interactive Documentation is a great way to explore the API without needing to log in https://blog.box.com/blog/introd...