Go to Navigation
Back to Articles

To Our Wonderful Beta-Testers

By Jakub Nesetril (jakubnesetril, jakub@apiary.io) on 21 May 2012

We've been working very hard for the last few months to bring you the best tools for your REST APIs out there. And we couldn't have done it without our amazing beta testers. We'll be releasing Apiary publicly soon, but before that happens, I wanted to thank you all for being such a great help to us. And since we've added so much to the original product based on your feedback, I wanted to take a minute to bring you up to speed with everything that's new in Apiary.

What's New

  • Proxy + Pass-Through—In addition to providing a mock server based on your API documentation, we've added a transparent HTTP proxy. Your API users can now access your real API server through Apiary and get all the benefits of visualising their API usage and comparing it to the provided documentation. Most recently we've started proxying all traffic to your API, even those resources that are not documented yet. This can be a great help in identifying and fixing gaps in your documentation. You can switch the proxy on your Settings page.

  • JSON Schema support—Sometimes comparing the data that your customers are sending to the documentation in a simple text diff is simply not sufficient to help your users debug the problem. We've added support for describing your data structures using JSON Schema. Your documentation can now have tightly integrated data validation! We're currently testing this, talk to us if your interested.

  • Partial Query-String support—If you're passing parameters to your API via querystring then these would not match existing API resources. That is, until we started ignoring querystring part of the URL for comparison purposes. We still plan on better URL parametrisation using URL Templates in the future.

  • Github Integration—Your API documentation should be versioned in the same way as your API code. Ideally even in the same repository—so that all your branching/versioning applies to both parts at once. We've added Github integration so that Apiary can update your documentation each time you push changes to it. Generic Git repository support still coming, let us know if you need it.

  • Private Traffic—Sometimes, the data you can be sending through the debugging proxy isn't exactly public matter. We've added support for randomized URLs for each user—thus you can send data to your own, private mock/proxy server, and view it only if you know the right URL.

  • Syntax Highlights + Code Samples—Our documentation now features code examples in different languages. Best of all—if you're missing your favorite language, feel free to write the language template and we'll include it promptly.

  • Many more—we've improved the traffic viewer greatly, we've added support for Cross-Origin Resource Sharing if you need that for your mock server, we've added support for HTTPS across the board—and many more. However, if there's something you're still missing, please do let us know.