Test API within the Documentation

We are using Swagger to document Worksnaps API. One neat thing about such API documentation is that you can test it right within the documentation.

Here is how you can test an API call.

  1. Enter your Worksnaps API token to the Current Tokenfield at the top of the page
  2. Choose the method you want to run and test. For instance, project listing method.
  3. Fill in all the necessary parameters' fields and press Try it out! button.

Figure 1

If the API call is successful, you will see the Response Code and Response Body.

Figure 2