The Goji development team use this site both internally and externally with partners to explain, present and allow interaction with all our API's.
Goji's API are integrated with the Swagger IO framework whose functionality is well summarized on its website: âSwagger is a simple yet powerful representation of your RESTful APIâ¦ The documentation of methods, parameters, and models are tightly integrated into the server code, allowing APIs to always stay in sync.â
Swagger provides annotations that decorate RESTful services and enables automatic documentation on things like service names, input parameters, response types and model and error codes. All of this is provided without having to write any kind of documentation.
Where the product really shows its power is in its ability to allow the APIs to be called from the generated documentation site from a standard web browser. Not only can you call all the APIs directly from this site, the site provides all the supporting documentation needed to access them in your own application.
The Goji REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
Additionally each API type has a path beneath the root. For instance, the "Quick Quote API" lists it's base as "/qq" so the URL to access /auto/carriers in the Quick Quote API is: