API GOVERNANCE

Enforce your API policies to runtime, design, and create development processes.

APIs as a Products

Digital Transformation has brought new business opportunities, enhancing new ways to bring value to customers. APIs have become enabler factors of companies’ transformation, bringing useful data to the customer journey, with a simple and intuitive interface. For this reason, now APIs are intended as products (AaaP), delivered on the market to open new channels and has become a core asset of every organization. As the most valuable thing in a company, APIs require more control than before: It’s now that the API Governance approach comes helpful.

API Governance

The Benefits of API Governance

  • Consistency: Guide teams with standardized APIs when it comes to delivering services;
  • Security: Implement authentication and authorization policies easily, thanks to standardized processes and APIs;
  • Stability: Deliver reliable consumer experiences with high-quality APIs;
  • Reusability: Make one API that can be used again and again across multiple applications, types of applications, and users.

Mia-Platform Console: one tool for full API governance

API Governance -2

Key elements of the API Governance

  • Versioning: Give a clear guide to your Devs and standardize the way APIs are versioned;
  • Tracking: Have full visibility of API lifecycle and APIs routes. Gather statistics and make your own rules;
  • Documenting: Setup interface standards used to publish APIs in the organization;
  • Deprecating: Employ standards even when an API has done with its job;
  • Integrating: See and monitor the relationships between APIs, consumers and subscriptions. Choose how to regulate these relationships;
  • Security: Define the security model employed on your APIs and the details to manage it.

 

How to build your API Strategy

Mia-Platform offers built-in and add-on components to enforce your API policies and implement your API Governance:

Internal Developer Portal (IDP) or Developer Hub:

IDP is an internal APIs catalog for internal development teams, where developers can find, consume, and test documented APIs.

External Developer Portal (EDP) or Developer Portal:

The Developer Portal is an APIs catalog exposed to external development teams, where developers can find and consume APIs. The External Developer Portal has functional and technical documentation and it allows to test APIs in a sandbox environment. EDP transforms your APIs into valuable and monetizable products.

Microservice=devportal

Application

Dev Portal

Use this application to set up your Developer Portal in a few clicks

Supported by

Microservice=apiportal

Plugin

API Portal

Use Mia-Platform core API Portal to expose the swagger documentation of your development services in one unique place.

Supported by

Microservice=microlc-devportal

Plugin

Dev Portal Backend

This plugin enables you to create the backend configuration for the dev portal.

Supported by

Microservice=docusaurus

Plugin

micro-lc Docusaurus Adapter

This adapter plugin enables you to embed inside your Dev Portal the docusaurus plugin as static site generator for you documentation.

Supported by

Microservice=docusaurus-1

Template

micro-lc Docusaurus Template

This template enables you to embed inside your Dev Portal the docusaurus plugin as a static site generator for your documentation.

Supported by

Microservice=redoc

Plugin

micro-lc ReDoc Plugin

This plugin enables you to embed inside your dev portal the ReDoc page for API's documentation.

Supported by

Microservice=microlc-devportal

Plugin

Dev Portal frontend plugins

This plugin enables you to create the foundations of the dev portal. It includes: micro-lc frontend, RapiDoc and Docusaurus adapter.

Supported by

Microservice=file-service

Plugin

File Service

Upload, download and handle your files using MongoDB, S3 or Google Storage.

Supported by

Microservice=authentication-service

Authentication Service

Use Mia-Platform core Authentication Service to provide OAuth2 compliant user authentication API.

Supported by

API Governance 3

The API Manager: the new role of API Governance

As the API evolves from an IT asset to a business asset, the API Manager role born out of a real organizational need to embrace this change.

API Manager: 

  • Has a complete overview of all exposed APIs;
  • Has both technical and business knowledge;
  • Provides guidelines to internal and external teams on the proper use of the APIs;
  • Manages the contents inside the Developer Portals;
  • Has access to technical and business views of APIs.

Enable consistency across your APIs with Mia-Platform Console

Related content

API Governance: the strategy for an effective management of your APIs

Read the article

API as a Product: why APIs are at the heart of digital business

Read the article

Understanding the benefits and limitations of GraphQL versus REST API

Read the article