API Reference

Developers Notes

  1. To help make the next few API endpoints easy to type, save your token to the console.

    bash NWAPP_API_TOKEN='YOUR_TOKEN'

  2. You will notice http used in the sample calls through this document, this is the Python command line application called HTTPie. Download the command line application by following these instructions.

  3. If you are going to make any contributions, please make sure your edits follow the API documentation standard for this document; in addition, please read Googles API Design Guide for further consideration.

Get API Version

Returns the version information of Comics Cantina. This is a useful endpoint to call when you are setting up your project and you want to confirm you are able to communicate with the web-service.

  • URL

/api/v1/public/version

  • Method

GET

  • URL Params

None

  • Data Params

None

  • Success Response

  • Code: 200

  • Content:

    json { "Service": "v0.1", "API: 'v1" }

  • Error Response

  • None

  • Sample Call

bash $ http get 127.0.0.1:8080/api/v1/public/version