We are a group of specialists with more then 12 years experience in gateways and middleware development.

As a growing platform, we are actively seeking collaborations to enhance our offerings.

• User-Friendly Interface:
  The editor features a clean and intuitive interface that makes it easy to create and modify OpenAPI specifications without needing deep technical knowledge.
• Autocomplete and Suggestions:
  Speed up your workflow with intelligent autocomplete and suggestions that help you fill in API details quickly and accurately.
• Schema Integration:
  Seamlessly integrate business schemas into your OpenAPI specifications, ensuring consistency and reusability across your projects.
• Future development will include more user frenadly options, Real-Time Validation, Version Control and Collaboration Tools

• Catalog Options

  To add a new API you must first go to Projects choose a project or create one and add a new catalog or select an existing one.

  On the catalog view you can choose from three options:
  1. Clone from Existing here you can clone, any OpenAPI as a new version from your environoment, to the specific catalog.
  2. Add New OpenAPI Service here you can crate an OpenAPI from scratch.
  3. Import from Raw text here you can import an existing OpenAPI artifact.
  
  
  

  Add new API

  
  Declare a first new path, path operations and path parameters and submit.
  
  After submitting, an OpenAPI artifact will be added to the specific catalog and you will be redirected to the editor view.
  The Artifact is ready for download from the three dots menu on the Info tab and can be retrived with the platform CLI and API. The API and CLI will be covered on integrations section.
  
  

  Download:

  
  

  Editor view:

  
  The view is divided in three groups Info, Paths and Components.
  Info
  Will show the respective fields from Info the OpenAPI artifact.
  The "Add new path" button will open an dialog where you can add a new path, path operations and path parameters to the specific OpenAPI artifact.
  
  Paths
  Will show all paths declared in the spacific OpenAPI artifact.
  When selecting a path, a list of operation Id's is desplayed according to specific path declaration.
  
  After selecting a operation, you can see its operation details where you can inspect the operation declarations.
  
  

  Clicking on "Edit operation" will allow you to modify the specific operation such as adding headers, query parameters, and cookie declarations.
  Soon, we will provide additional options, including removing and adding responses and modifying the request body.

  
  Components
  

  Find all the declarations for the specific OpenAPI artifact.
  From the menu you can navigate between parameters, responses, schemas and a option to add a new schema to the environoment or loading a existing schema that after can be edited or added to the specific OpenApi artifact.
  Parameters Find the declarations for operation parameters as header, path, cookie and query parametes.
  Responses See the default responses added when you created the OpenAPI artifact.
  Schemas See the schemas avaiable with the OpenAPI artifact.
  

  
  For adding a New schema go to the Schema section.
  The designer has limited functionality on imported external OpenAPI.
  More options:
  - Edit Info
  - Remove Path
  - Remove Operation ID
  - Add, edit, remove responses and request body.
  
  

Intuitive Interface:
Easily add, remove, and organize schema components without needing deep technical knowledge.
Reuse objects:
Start quickly with predefined schemas that can be customized to suit your specific needs.
Field Types and Constraints:
Define various field types (e.g., string, integer, date) and set constraints (e.g., required fields, value ranges) to enforce data integrity.
Integration with OpenAPI:
Seamlessly integrate your schemas with OpenAPI specifications to maintain consistency across your API and data models.

Schema editor can be accessed from Business Schemas view or from the OpenApi editor.
The empty schema editor is a bit different depending on the scope that has been opened:

Opened from Business schema view: the editor will show more options to set for the specific schema object and have a form generator tab after the YAML generator tab.

Opened from OpenAPI editor: you will have an option to add the specific schema to the OpenAPI artifact.

Business Schemas empty editor

OpenAPI empty editor

Add new Schema

Add a schema name or choose from suggestions and press Add to editor.
If the Schema exists it will be loaded to the editor.
If the schema does not exist, the editor will add a new object with a field with the name "New field".
The schema will be saved only after a sibling is added.

To add a sibling, go to the three dots menu of "New Field" and a menu will open, with an Add Sibling option.

Now you must define the sibling you want to add:

Color of field may differ, according to the field type.

Types

• Objects will be displayed in gray
• Arrays will be displayed in blue
• All primitive types will be displayed in green.

The menu options for a field varies, depending on its type:

• Primitive Types: For primitive types (e.g., string, number, integer, boolean, null), you can:
  • Add Sibling: Add a new field to the same level as the selected field.
  • Edit Field: Modify the properties of the selected field.
  • Delete Field: Remove the field from the definition.
• Complex Types: For complex types (e.g., objects, arrays), you can:
  • Add Sibling: Add a new field to the same level as the selected field.
  • Add Child: Add a new field within the selected complex type. This option is only available for complex types.
  • Delete Field: Remove the field from the definition.

• Add Sibling:
  This action allows you to add a new field at the same hierarchical level as the selected field. The new field will be part of the same object as the selected field.
• Add Child:
  Available only for complex types, this action lets you add a new field within the selected complex type (e.g., inside an object). Adding a child field to an object will create a connection between the specific field and the object is added to only. This enables object reuse across different schemas.
  We recommend giving meaningful names to your objects because object names must be unique.
  You cannot create multiple objects with the same name but different fields.

If a field is displayed in the editor, it indicates that the schema is valid and can generate the corresponding YAML, JSON, and Form outputs.

Schema version,Inheritance and Polymorphism are not supported yet.

You can download the OpenAPI from our public catalog Here

First generate a JWT suited for the use porpose on the menu Settings.

• Get schema object Retrive any schema by name

  
  curl --location -g --request GET 'https://gst-hub.com/api/objects/{schemaName}' \
  
  --header 'Authorization: jwt {{token}}'
                                          
                                      

• Get OpenAPI definition Retrive any OpenAPI by title and version

  
  curl --location --request GET 'https://gst-hub.com/api/openapi/{openAPITitle}/{version}' \
  
                                        --header 'Authorization: jwt {{token}}'
                                          
                                      

• Get OpenAPI operatioId Retrive any operationId from OpenAPI title and version

  
  curl --location --request GET 'https://gst-hub.com/api/openapi/{openAPITitle}/{version}/{operationId}' \
  
                                        --header 'Authorization: jwt {{token}}'
                                          
                                      

• Update status commit After GitHub push the pushed resource will have a status with an unique GUID. You can update the specific GUID when used with DEVOPS for version tracking.

  
  curl --location --request POST 'https://gst-hub.com/api/updateCommit' \
  
                                        
                                          --header 'Authorization: jwt {{token}}' \
  
                                          --header 'Content-Type: application/json' \
  
                                          --data-raw '{
  
                                              "message":"Deploy Env Test",
  
                                              "gid":"05114a91-a3fb-4d9b-af80-82268d83ffb4",
  
                                              "description":"test outgoing"
  
                                          }'