Skip to main content

69 docs tagged with "API7 Enterprise"

View All Tags

Building Developer Portal Site

This article will guide you on how to publish an API that has already been integrated with the API7 Gateway to the developer portal associated with the gateway. You will set up a site that allows internal or external developers to log in and find this API, view its corresponding documentation, and apply to subscribe to the API. Once approved by the API administrator, developers will automatically obtain access credentials.

CentOS

For PoC use,this post will guide you to install all components on the same machine.

CentOS

This is the PoC installation guide. API7 Gateway and other components are deployed on the same machine. If you're looking for production solutions, please contact us.

Certificate Management

Dashboard has built-in SSL certificate management system, which can manage SSL certificates in the cluster manually or by uploading files.

Collect Data Plane Access and Error Logs with Grafana Loki

Grafana Loki is an open-source logging and monitoring system developed by Grafana Labs. It is designed to handle large volumes of log data and provides a highly scalable and efficient solution for log aggregation, storage, and analysis. With Loki, users can centralize logs from various sources, monitor and analyze log data in real-time, and gain insights into system behavior, performance, and troubleshooting.

Consumer Management

Dashboard has built-in consumer module, which refers to the consumer of a certain type of service and can only be used with the user authentication system.

Create API without Upstream

Binding upstream for APIs is mandatory according to the API7EE restrictions. However, based on the principle of our gateway, we can execute the logic and terminate the forwarding process before the request is actually forwarded upstream.

Designing APIs

As engineers, we always emphasize the importance of designing a plan before coding.We need to clarify the functional purpose of an API based on the business requirements and then translate the business language into technical language. Typically, API planning and design revolve around documentation.

Developer

Only when you does not have an available account system, the developer module built in the developer portal can be used to provide the most basic email login method and save developer account data in the developer portal.

Developing APIs

This guide will instruct you on how to develop high-performance and healthy APIs based on the completed API design document.

Docker Installation

This guide will walk you through the rapid deployment of all essential components of API7 Enterprise on a single machine for PoC feature verification. Once the deployment is complete, the address of this machine will serve as the API7 Gateway address.

Enable Custom Plugin

Users can extend the functionality of API7 Gateway by writing custom plugins, and injecting their own code into API7 Gateway's daily workflow. Examples are integrating additional protocols or systems, ultimately achieving centralized management at the gateway level.

Enabling API Authentication

Authentication is one of the fundamental requirements for APIs, and API7 Enterprise supports a wide range of authentication methods, such as key-auth, basic-auth, ldap-auth, and more.

FAQ

Frequently Asked Questions

Gateway Nodes

Dashboard built-in gateway node module, so that users can view API7 node information.

Get License

After installing API7 Enterprise, you need to obtain a license and upload it for activation.

High Availability

This post guides you on deploying API7 Enterprise Edition with a minimum version of high availability, including high availability on the Data Plane (API7 Gateway), Control Plane (API7 Dashboard), and the etcd cluster.

Integrate with Apache SkyWalking

Apache SkyWalking is an application performance monitor and observability analysis platform for distributed systems. It provides multi-dimensional application performance analysis methods and alarm features from call chain tracing to associative log analysis. At the same time, it is also one of the most popular applications performance monitor systems.

Introduction

1. This post guides you on deploying API7 Enterprise Edition for PoC (Proof of concept) only. You can apply for a 30-day free license at Free Download page.

IP Restriction

API Gateway supports IP Ranges or multiple IP, refer to https://apisix.apache.org/docs/apisix/plugins/ip-restriction/

LDAP

Set up API Gateway with LDAP

Management of resources

More and more enterprises will run multiple API7 clusters and etcd clusters internally, and the API7 Dashboard supports the ability to visually configure gateways in the case of multiple clusters.

Monitoring Reports

You can quickly understand the routing situation under the current cluster on the monitoring page, which includes the following indicators:

Overview

API7 Dashboard is a browser-based visual platform for monitoring and managing API7.

Platform Architecture

API7 Dashboard is based on the Apache APISIX Dashboard and maintains the same platform architecture.

Publishing API to API7 Developer Portal

This article will guide you, as an API provider, on how to publish an API to the developer portal. This will allow internal or external developers to log in and find this API, view its documentation, and apply for API subscriptions to obtain access credentials upon approval by the API provider or administrator.

Publishing APIs to API7 Gateway

Once the API development is completed, it needs to be published to the API7 Gateway to leverage various powerful capabilities offered by API7.

Rate Limiting

This article will guide you on how to configure rate limiting and throttling for APIs using the limit-count plugin on the API7 dashboard, and how to validate the results.

Rate Limiting

APISIX/API7 EE actually supports three rate limiting models for HTTP, which are:

Request Query and Path Manipulation

This demo is intended to demonstrate the APISIX capability, i.e., the ability to handle specific business logic in a programmable manner. No hint is included that it can be used in a production environment, where it should be solidified as a plugin and fully tested.

Role Management

RBAC is a role-based resource access control mechanism. The API7 Dashboard controls the permissions that users can access resources by assigning roles to different users.

Setting

Edit Developer Portal Address

SOAP Proxy

SOAP is an old and complex protocol with many specifications and extensions, making it difficult to support it directly and ensure that it is implemented correctly.

Subscribing API in Developer Portal

This article will guide you as a developer on how to log in to the developer portal, apply for API subscriptions to obtain access credentials, and successfully call the API.

User Login

Access the dashboard URL through the browser, the login page will be displayed when you are not logged in. After entering the account and password, click the login button to log in.

User Management

Dashboard supports user management system for managing internal staff information.


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN PTE. LTD 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation