Skip to content

Home

Introduction

Development

IDEs

Services

API Explorer

Releases

Release notes

Martini Runtime

Martini Desktop

Martini Online

Feature requests

Bug reports

Creating a Gloop REST API

You can create a new Gloop REST API from scratch, or generate one from an existing definition1. Below are the procedures you have to follow if you want to create a new REST API:

Creating a new Gloop REST API

Creating a new Gloop REST API

  1. Launch Martini's Gloop API wizard.

    This is done by going to the Navigator, right clicking on any code directory where the API will reside, and then selecting New > Gloop API wizard from the appearing context menu.

    Launch the wizard using keyboard shortcuts only

    In Martini Desktop, you can open the Gloop API wizard using the Wizard launcher. To open the Wizard launcher, press . To finally launch the Gloop API wizard, select "Gloop API" from the provided list of wizards in the dialog. To filter displayed wizards, type api in the dialog's search bar.

  2. Select Publish as the type of action, then click Next.

  3. Specify the name of the API and ensure New REST API is selected; then click Finish or Next again.

    If you want to provide other details of your API later (such as its description, version, terms), then you may now click Finish. Choosing this option will open your API in the REST API editor immediately. You may ignore the succeeding steps in this guide.

    If you would rather enter your new Gloop API's details now, click Next.

  4. Choose None as the source, then click Next.

  5. Enter the version, title, and license name onto their corresponding text boxes. Click Next. These will be ported to the Swagger or OpenAPI definition of your API.

    Providing API general information

    Providing API general information

    Auto-complete

    The license text field has an auto-complete feature that suggests commonly used licenses.

  6. Enter the documentation URL and (optionally) add a description for it. Click Next.

    Providing API documentation information

    Providing API documentation information

    Use Markdown in your description

    As per the specifications of OpenAPI and Swagger, description fields allow CommonMark2. And for your convenience, Martini allows you to preview the Markdown as you edit it.

    You can shift the arrangement of this Markdown editor using the following buttons in the wizard, located beside the text area:

    • Show source only
    • Show source and preview
    • Show preview only
    • Toggle horizontal or vertical orientation
    • Back
    • Forward
  7. (Optional) Add tags for your API. Click Next.

  8. Enter a path you would like to expose through your API. Click Next.
  9. Choose a service for the path specified in the previous step. Click Next.

    Selecting a service for the API's first operation

    Selecting a service for the API's first operation

  10. Finally, choose the HTTP request method for the operation you entered. Click Finish. After this, the Gloop REST API editor will open and display your newly created Gloop REST API.


  1. Including required models and services

  2. See Rich Text Formatting