One of my focuses on the veneer framework was documentation. I feel like it does a pretty decent job on its own of making all of the information you would need about your endpoints available. What it doesn't do, however, is provide a user-friendly interface that makes you look like an API superstar. I'm not much of a UI designer. In fact, I'm pretty awful at it, so I didn't try to write my own.
Recently I was introduced to iodocs to help in documenting API's in an explorable, interactive fashion that would encourage integration. Since node.js was not already part of the technology stack in the veneer framework, I decided to look around a bit more and discovered swagger. Swagger fits nicely with veneer because it can consume JSON documentation exposed by your own RESTful web service, which the veneer framework already had! Granted, the default format of the veneer documentation doesn't quite match the Swagger 1.1 specification, but it was easy enough to kludge a decent little extension that would massage veneer documentation into a format that the swagger-ui could consume.
Browse the source on Github
What does it do?
veneer-swagger is an extension to the veneer framework that will massage the usual endpoint definitions into usable swagger documentation format. This means you can have web documentation, developer experimentation tooling, and example client code generation, without writing any extra code!
What is Swagger?
Swagger, per its project page at http://swagger.worldnik.com, is:
a specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services.
How do I use veneer-swagger?
A minimal implementation involves:
- Downloading swagger-v1.php
- Including swagger-v1.php in your code, as you would any other API endpoint
- Installing swagger-ui on a webserver
- Pointing swagger-ui at [your-api-url-here]/v1/swagger
If your API is publicly accessible, you could even "try before you buy" by visiting the online demo, changing the URL field to point to [your-api-url-here]/v1/swagger, and pressing the "Explore" button. Instant documentation!
Since Swagger is run entirely in your browser, it is susceptible to the same origin policy. To work around this (and there are many ways), a few things you might do could include:
- If you are using Apache, add a header to every request within an Apache directory tag:
Header set Access-Control-Allow-Origin "*"
- Within your endpoint code, set an access control header:
- Run swagger and your API code within the same domain