OpenAPI Bot

OpenAPI Bot

Chat with the bot to get up to speed with a Web API.
Quickly discover what you can do with the API
without having to go through all its documentation pages




  • OpenAPI Bot is a chatbot designed to answer questions regarding Web APIs by leveraging their OpenAPI definitions.

  • OpenAPI Bot supports both JSON and YAML and includes a built-in support for validation.

  • OpenAPI Bot is implemented using Xatkit, a generic and extensible platform for developing chatbots.

  • OpenAPI Bot relies on DialogFlow to better understand your questions.

  • OpenAPI Bot is open source and licensed under the Eclipse Public License 2.0.

HOW IT WORKS

OpenAPI bot animated GIF 1

LOAD THE API

Just enter the URL of your OpenAPI definition to bootstrap the conversation. The bot supports both JSON and YAML. Examples:

  • Load the API https://petstore.swagger.io/v2/swagger.json
  • Load the OpenAPI definition located at https://petstore.swagger.io/v2/swagger.yaml
OpenAPI bot animated GIF 2

ASK A QUESTION

Ask a question regarding what you want to know. OpenAPI bot will provide you information about the API. Examples:

  • How to contact the developer of the API?
  • Give me a summary of this API
  • Show me the list of paths in the API
  • Tell me about the path /pet
  • Show me the schema definitions
  • Which operations return a Pet?
OpenAPI bot animated GIF 3

ASK A COMPLEX QUESTION

OpenAPI bot relies on a set of heuristics to provide advance details which are not visible at first glance. The supported requests so far are:

  • Are there operations which use the properties of Pet?
  • Are there links between Pet and other definitions?
  • Which operations do I need to change if I change the schema Pet?

WHO WE ARE

Hamza Ed-douibi picture
Hamza Ed-douibi
Gwendal Daniel picture
Gwendal Daniel
Jordi Cabot