CirrusWave tools


cirruswave tools

Documentation is available for every service and is automatically generated. The following are the locations of the url for each service
Documentation
url: <protocol>://<hostname>:<port>/documentation
Sampleservice
url is https://localhost:8888/documentation
Systemservice keymgr
url is https://localhost:4003/documentation
Service Portal

This is gateway to auto-generated documentation as well as API testing tools.

  • Services button takes you to detailed documentation on the services available
  • API Test button will give you testing tools
Services

This tool lists out all the services available as part of the application or system services depending on which ports you are requesting the documentation from

  • Sidebar
  • Used for navigation within the page
  • List of the services to navigate to it's content
  • Content area
  • General description of each service
  • Link to detailed documentation for the service routes that are available. See the next topic
  • If the service requires any options to be passed in at the initialization time these will be shown as JSON Schema
Routes

For each service this lists the routes(REST endpoints) exposed

  • Sidebar
  • Used for navigation within the page
  • List of the routes plus methods. You can use this to browse and also jump to specific REST endpoint
  • Content area
  • Route signature plus parameters
  • Description of the route
  • Depending on what's present in the config file for the service, various optional items will be shown
  • Optional items include JSON Schema descriptions for params, request body, examples for calling the route and method.
Test microservices developed using cirruswave

Enables testing of each of the services

  • There are two components in this tool
  • To the left is a tool to test a specific service, route and a method
  • To the right is a tool to browse different services, routes and method
  • As you browse the services using the right side, the left side form is auto-filled with the route, method and default parameters
Generic test tool for testing any REST endpoint

Enables testing of the REST endpoints

  • There are two components in this tool
  • To the left is a tool to test a specific REST endpoint. You can mention the protocol(http or https), hostname, port, route, method and payload
  • To the right is a tool that generates authentication header
  • if the REST endpoint requires authentication header you can use the Generate authentication tool to generate one. It autofills the Authentication header, nonce and date fields for the REST endpoint testing tool