Information roadmap for Zowe API Mediation Layer

This roadmap outlines information resources that are applicable to the various user roles who are interested in Zowe API Mediation Layer. These resources provide information about various subject areas, such as learning basic skills, installation, developing, and troubleshooting for Zowe API Mediation Layer.

The following definition of skill levels about Zowe assist you with gathering the most relevant resources for you.

• Beginner: You're starting out and want to learn the fundamentals.
• Intermediate: You have some experience but want to learn more in-depth skills.
• Advanced: You have lots of experience and are looking to learn about specialized topics.

Fundamentals

Zowe skill level: Beginner

• Zowe API Mediation Layer overview

  New to API Mediation Layer? This overview topic introduces the key features, main components, benefits, and architecture of API Mediation Layer.

• Architecture

  Review the Zowe architecture to understand how API Mediation Layer works in the Zowe framework.

Installing

Zowe skill level: Beginner

• System requirements

  Review this topic to ensure that your system meets the requirements for installing the API Mediation Layer. API Mediation Layer is one of the server-side components.

• Planning

  This article includes details about planning for installation, the Zowe z/OS launch process, and information about the Zowe runtime directory, instance directory, and keystore directory.

• Installing API Mediation Layer

  This article provides an overview of the essential steps involved in installing API Mediation Layer.

Configuring and updating

Zowe skill level: Intermediate

• Configuring API Mediation Layer

  • API Gateway configuration parameters

    This article introduces the default configuration of the API Mediation Layer and how to change the parameters to meet your needs.

  • Configuring the Zowe APIs

    The article explains how to configure security for the Zowe API Mediation Layer.

  • Advanced Gateway features configuration

    This article is for system programmers who want to configure advanced Gateway features of the API Mediation Layer, such as the gateway retry policy, connection limits, gateway timeouts, and so on.

• Upgrading the z/OS system for Zowe

  Learn how to upgrade the z/OS system for Zowe.

Using Zowe API Mediation Layer

Zowe skill level: Intermediate

• Using API Catalog

  Learn about how to use the API Catalog to view what services are running in the API Mediation Layer. Through the API Catalog, you can also view the associated API documentation corresponding to a service, descriptive information about the service, and the current state of the service.

• Blog: Introducing “Try it out” functionality in the Zowe API Mediation Layer

  This blog talks about one key functionality of the Zowe API Mediation Layer to validate that services are returning the expected responses.

• Docs: Zowe API reference guide

  Find and learn about the Zowe APIs that you can use.

Onboarding APIs

Zowe skill level: Advanced

• Extend Zowe API Mediation Layer

  Learn how you can extend the Zowe API Mediation Layer. Extenders can build and onboard additional API services to the API ML microservices ecosystem. REST APIs can register to the API Mediation Layer, which makes them available in the API Catalog and for routing through the API Gateway.

• Onboarding overview

  This article provides details about onboarding a REST API service to the Zowe API Mediation Layer.

• Zowe API ML repository

  If you want to start working with the code immediately, check out this code repository.

Security

Zowe skill level: Advanced

• API Mediation Layer Security

  This article describes how API ML uses Transport Layer Security (TLS). Use this guide to familiarize yourself with the API ML security concepts.

• Zowe API Mediation Layer Single-Sign-On Overview

  This article provides an overview of the API ML single-sign-on feature, the principle participants in the SSO process, and links to detailed Zowe SSO documentation.

• Blog: The ZAAS Client: a library for the API Mediation Layer

  This blog introduces you to Zowe Authentication and Authorization Service (ZAAS) Client — a library that contains methods for retrieval of JWT tokens, PassTickets, and even verifying JTW token information.

• Blog: Single-Sign-On to z/OS REST APIs with Zowe

  This blog takes a deeper dive in to the SSO feature of API ML.

• Blog: Zowe client certificate authentication

Contributing to Zowe API Mediation Layer

Zowe skill level: Advanced

• Contributing guidelines

  This document is a summary of conventions and best practices for development within Zowe API Mediation Layer.

• Conformance Program

  This topic introduces the Zowe Conformance Program. Conformance provides Independent Software Vendors (ISVs), System Integrators (SIs), and end users greater confidence that their software will behave as expected. As vendors, you are invited to submit conformance testing results for review and approval by the Open Mainframe Project. If your company provides software based on Zowe CLI, you are encouraged to get certified today.

• Blog: Zowe Conformance Program Explained

  This blog describes the Conformance Program in more details.

Troubleshooting and support

• Troubleshooting API ML

  Learn about the tools and techniques that are available to help you troubleshoot and resolve problems. You can also find a list of common issues about Zowe API ML.

• Error Message Codes

  Use the message code references and the corresponding reasons and actions to help troubleshoot issues.

• Sumit an issue

  If you have an issue that is specific to Zowe API Mediation Layer, you can submit an issue against the api-layer repo.

Community resources

• Slack channel

  Join the #zowe-api Slack channel to ask questions about Zowe API ML, propose new ideas, and interact with the Zowe community.

• Zowe API ML squad meetings

  You can join one of the Zowe API ML squad meetings to get involved.

• Zowe Blogs on Medium

  Read a series of blogs about Zowe on Medium to explore use cases, best practices, and more.

• Community Forums

  Look for discussion on Zowe topics on the Open Mainframe Project Community Forums.