March 3, 2008
ApiTest: A Tool for Testing Service APIs
BrigetteK @ 4:18 pm
As you might already know, all Deki Wiki functionality is exposed through a service API that can be invoked via HTTP requests. I have developed several client applications that consume the Deki Wiki API, such as the Desktop and Outlook connectors. During the development process, I was wishing for a tool to make it easy for me to view and experiment with the API… so I decided to write Apitest.exe.
Apitest.exe is a Windows application that enables users to view a list of all service features/parameters and invoke them. It works with any Dream service, but I mostly use it with the Deki Wiki service. To run Apitest:
- Install Dream SDK & Source
- Navigate to the install destination and copy \src\mindtouch.apitest\DefaultData.xml to \redist.
- Launch redist\mindtouch.apitest.exe
- Select File->Load Blueprint From… and enter your Dream service location (for Deki Wiki, enter http://<hostname>/@api/deki)
- You are now ready to try out any of the service features! Note: if you’re connecting to the Deki Wiki API service, many requests require an authenticated user; it is a good idea to first login. Select Get:users/authenticate, enter your credentials, and Submit. In the results tab, you will see the headers and data returned from the request. All subsequent requests will be made with these credentials.




No Comments »
No comments yet.
RSS feed for comments on this post. TrackBack URL
Leave a comment