Skip to content

Home

Introduction

Development

Overview

IDEs

Services

Service manager

API Explorer

Creating a Gloop REST API

You can create a new Gloop REST API from scratch, or generate one from an existing definition1. Either way, you must first do the steps below:

Creating a new Gloop REST API

Creating a new Gloop REST API

  1. Launch Coder's Gloop API wizard.

    This is done by going to the Coder 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 Coder Studio, 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 create a Gloop REST API from scratch but 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. If you would rather enter your new Gloop API's details now or create a Gloop REST API from an existing definition, click Next.

From scratch

Continue using the wizard if you want to provide the details of your new API immediately.

  1. Choose None as the source, then click Next.
  2. 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.

  3. 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, Coder 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:

    • Source view
    • Source and Preview view
    • Preview view
    • Orientation toggle (toggles the preview being beside or underneath the source while in the Source and Preview view)
    • Preview back
    • Preview forward

    The last three buttons aren't supported in Coder Cloud.

  4. (Optional) Add tags for your API. Click Next.

  5. Enter a path you would like to expose through your API. Click Next.
  6. 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

  7. 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.

From existing

Procedures for generating Gloop APIs from existing definitions are discussed in this document. Ensure REST API is selected as the type of API.


  1. Including required models and services

  2. See Rich Text Formatting