Delivering a microservice

Share a runnable with other users

  1. In a runnable’s detail page, click “Share”
  2. Choose what permissions to grant to what users and groups
  3. (Typical scenario) select “Can execute this runnable” and “Can retrieve this runnable” permissions and choose “Developers” group. Then click “Share” so that developers can make requests to this runnable
_images/share_runnable_3.png

Creating an API documentation

  1. Upon your first successful run request, the input and output of the run will be automatically analyzed to create an API documentation. Go to a runnable’s detail page, make a successful request, come back to the runnable’s detail page to confirm you have your API documentation
_images/create_api_doc_1.png

Editing an API documentation

  1. In a runnable’s detail page, click “Edit JSON Schema”
  2. Edit the documentation information as you wish. Click “Edit JSON Schema” to submit
  3. For more information on JSON schema, please refer http://json-schema.org/
  4. Input JSON Schema can be used to validate input (refer Managing a microservice – Configure to validate input data first)
  5. Input JSON Schema also decides how AUTO GUI section displays in the runnable’s detail page (refer Using a microservice – Using Auto GUI)

Delivering an API documentation by email

  1. Under the API Documentation section of a runnable’s detail page, click “Email API Doc” to send the API documentation in markdown syntax to external users
_images/deliver_api_doc_1.png _images/deliver_api_doc_1.1.png

Delivering an API documentation as a text file

  1. Click “Download TXT” below the API Documentation section of a runnable’s detail page, click “Download TXT” to download the API documentation in the markdown format to your local computer. Send it to the users you want to share the documentation.