API Governance

APIs can be documented and monitored in real-time, with all API documentation centralized, searchable, and accessible from within a private GrokOla instance.

GrokOla users can use an integration mechanism to have API documentation automatically imported upon build or import Swagger content manually into GrokOla.

API Management vs. API Governance

This is not API Management, it’s API Governance.

All API documentation and monitoring is consolidated to one place. GrokOla focuses on four types of API information: real-time usage statistics, automated API structure mapping, big-picture wiki documentation, and visual representations.

GrokOla has both automatic and manual populations of API documentation into your private GrokOla instance. API information can be automatically updated upon build or through a manual Swagger (Open API) import,.

  • Connector.

    API Analysis & Statistics

    Real-time usage stats for when my APIs are used, how often, and server duration. Where it’s deployed, where it’s consumed, and by what IP addresses.

  • Connector.

    API Documentation

    Available API routes & resources including what they do, how to access, and examples of use.

  • Connector.

    Wiki Documentation

    The bigger picture of what the API is all about. Linked wiki documentation including examples of use, authentication instructions, structure, and more.

  • Connector.

    Visual Diagrams

    Visual representation of my API using a simple drag-and-drop editor, MockOla.

See API Governance In Action


How API Governance Is Implemented

Real-time API statistics are provided to GrokOla through a simple process. Essentially, you will install an “API Watch Agent” to your application, wherever it is deployed using the associated technology Watch Agent implementation. This allows API usage stats to be emitted to GrokOla for governance.

GrokOla has API watch filters are currently available for .NET, Node, and Java, but additional languages are soon to come.

The OpenAPI Specification (fka Swagger) is widely recognized as the most popular open source framework for defining RESTful APIs. It’s 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. GrokOla users can upload OpenAPI/Swagger JSON files into GrokOla manually.

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.