What is NaturalAPI?

NaturalAPI is a toolkit able to automatically generate application programming interfaces (APIs) and related unit tests for a given programming language, starting from features and scenarios in Gherkin format and from text documents related to the domain of interest.

The project is created by the FourCats team for the Software Engineering exam of the Degree Course in Computer Science of the University of Padua.

More information can be found by consulting the documentation.

To begin with:

In particular, NaturalAPI is composed of three distinct modules: NaturalAPI Discover, NaturalAPI Design, NaturalAPI Develop. Each module is independent of the others, so you can only run one module at a time.

To download and use a module:

  1. Click on the button of the module you want to download;

    If you prefer you can also download the CLI version of the product at the bottom of the page

  2. Each module have differents needs:
    • NaturalAPI Discover: needs in input a series of text file in .txt;
    • NaturalAPI Design: needs in input .feature files in Gherkin format and also can receive in input a BDL generated by the module Discover;
    • NaturalAPI Develop: needs in input a valid BAL, the output of the module Design in JSON format, and PLA in txt format;
  3. To start the execution of the selected module follow the instructions in the User manual supplied with the product: the user can start the program via Command Line Interface (CLI) or Graphic User Interface (GUI).

N.B. The format of the files needed by the modules can be found in the User manual v.1.0.0.

To download the entire repo:

  1. Click the “View on Github” button;
  2. Click on the “Clone/Download” button;
  3. Download the repo in .zip;
  4. Pull it out to the desired position;
  5. To start running the program follow the instructions in the User manual supplied with the product.

Download the CLI version of NaturalAPI here: