Introducing Interactive API Documentation

At Box, we strive to deliver best-in-class API documentation to make it as easy as possible for developers to learn about our APIs.

Beyond just reading the documentation, we know developers will want to get hands on with an API to see how it works. While there are a number of ways you can test an API (using a tool like Postman), we wanted to bring that experience directly into our documentation with a more interactive documentation experience. That way, you can read about the API and test it out in one place instead of having to toggle between tools.

Today, we're excited to announce an interactive API explorer as part of our API documentation. This is available now in our documentation for you to try right away.

You can check out an overview of our interactive documentation feature here:

Interactive documentation allows you to test any API endpoint in our documentation with your own custom parameters and see the call and response structure for that endpoint. Now, you can easily see how your app can interact with our API and even copy-and-paste code snippets to use in your development.

The API explorer feature integrates seamlessly into the Box API documentation. You can select any CRUD endpoint in our API reference documentation and you'll see a button to "Try It."

In order to try an API call, you'll need to specify at least the required parameters. Once you've inputted the parameter, you can click try it and you'll see a code sample on the right side of the page.

Now, you can copy the code sample and use it in your app! You can also try specifying other parameters to see how the response changes.

We've also introduced a new search functionality that lets you easily search across all guides, reference, and pages of our documentation site. The search bar, located in the top-right corner, features a real-time search result that populates as you type. Now, you can easily jump to the exact guide or endpoint you're looking for.

If you have any questions about these new features or the Box API documentation in general, you can reach out to us on Twitter (@BoxPlatform) or post a question in the Box Developer Forum.

 

Tags: box-api