Screencast: Importing Swagger / Open API JSON Into GrokOla

grokadminAPI Governance, Features0 Comments

As a part of its API Governance features, you can manually import Swagger / Open API Specification JSON files into GrokOla.

This new screencast walks you through the process of manually importing Open API JSON file and seeing that documentation read into GrokOla. API routes are categorized (by get, put, post, delete) and include description of shapes, parameters, and usage documentation.

The OpenAPI Specification (fka Swagger) is widely recognized as the most popular open source framework for defining RESTful APIs. It is language agnostic and both human and machine readable. OpenAPI maps all resources and operations associated with APIs, defining a set of files required to describe such an API.

API Governance Overview

 

This feature helps you to keep all API documentation and monitoring consolidated to your GrokOla instance. GrokOla focuses on four types of API information: real-time usage statistics, automated API structure mapping, big-picture wiki documentation, and visual representations.

You can ‘watch’ certain routes for changes. By watching a route, you will be notified if any other user made a modification or if continuous processes update it.

Additionally, there is a GrokOla integration API that allows Swagger JSON to be uploaded automatically to GrokOla with a RESTful API. This allows continuous integration systems to update API documentation during the build process, then updating GrokOla.

Just Another Feature of GrokOla

GrokOla is a web-based wiki tool for development teams that supports knowledge transfer. Users can create, query, and share wiki content & mockups with their team from anywhere via its web-based or mobile platform.

CODE-SENSITIVE WIKI

GrokOla provides a centralized wiki for the Tribal Knowledge needed by your team. Code solutions and APIs are documented using simple markdown syntax and language-sensitive editors.

MOCKOLA

MockOla is a rapid design tool that allows users to easily create user interface mockups, wireframes, and visual concepts. Users lay out simple user interfaces configurations using a drag-and-drop element editor with various design palettes like user interface constructs, UML Modeling, shapes, text, and more.

QUESTION & ANSWER WORKFLOW 

Users can ask detailed development questions to members of their own teams. Once an answer is accepted, it is made available by search to all users of your private instance. No knowledge slips through the cracks!

Leave a Reply