API management platform XXL-API

Xxl-api is an easy-to-use API management platform that provides API “management”, “documentation”, “Mock” and “test” functions. Now open source, out of the box.

• The Servlet/JSP Spec: 3.0/2.2
• The JDK: 1.7 +
• Tomcat: 7 + / Jetty8 +
• Mysql: 5.6 +
• Maven: 3 +

Please download the project source code and unzip it to obtain the “Initialize SQL script”, script location:

/xxl-api/db/xxl-api-mysql.sql
Copy the code

After deploying the application “xxl-apI-admin” in a container such as Tomcat, access the following interface after startup:

Description of project attributes:

Project name: Project name; Project description: Description of the project; Access rights: "public" rights, indicating that all people can operate; "Private" permission, which means that only the administrator or project members can operate (in the function self-test, will be pushed); Address - online environment: the project online environment and the address, the project API shared the address; Address - Pre-release environment: project pre-release environment and address; Address - Test environment: project test environment and address; Version: Version information of the project;Copy the code

In the project management interface, click the “Enter project” button on the right of the project to enter the interface management interface, as shown below:

Description of interface group attributes:

Group name: Name of the group Group Sort: sorting order of the group. The smaller the value is, the earlier the value is.Copy the code

• Update API grouping

In the “left interface Group area”, click the corresponding API group, and the list of API interfaces under this group will be displayed on the right side. As shown below, click the “Edit Group” button at the top of the interface list (this function is available only for new API groups) to modify the API group information;

• Deleting API Groups

In the “left interface Group area”, click the corresponding API group, and the list of API interfaces under this group will be displayed on the right side. Click the “Delete Group” button at the top of the interface list (this function is available only for new API groups) to modify the API group information;

API attribute description:

Basic information: Interface group: indicates the group to which the interface belongs. Interface status: Indicates the status of the interface. In the interface list, the enabled interface is identified by a green circle, the maintenance interface by a yellow circle, and the abandoned interface by a gray circle. Request method: request method, such as POST, GET, etc. Interface URL: Indicates the URL address requested by the interface. Note that this is a relative address, and the trailing address is obtained from the trailing address attribute of the owning project. Interface name: indicates the interface name. Request header: The same interface supports multiple request headers. Header tag: The type of the request header, such as accept-encoding; Header: Data in the request header, such as the accept-encoding header utF-8; Request parameters: Multiple request parameters can be set on the same interface. Mandatory: Specifies whether this parameter is mandatory. Parameter type: Data type of the parameter, for example, STRING. Parameter name: Parameter name; Parameter description: Parameter description; Response result: You can set Successful response result and failed response result as reference for interface response data. Response data type (MIME) : Response result type, such as JSON or XML; Response result data: Response result data. For example, if the response result type is JSON, you can set the response result data to JSON data. Response result parameters: supplementary description of parameters in Response result. For example, if the response result type is JSON, the parameter information of each JSON field can be listed here. Non-empty: Whether this parameter can be empty. Parameter type: Data type of the parameter, for example, STRING. Parameter name: Parameter name; Parameter description: Parameter description; Interface remarks: Interface remarks in MarkDown mode.Copy the code

• Update the API

On the API interface management interface, click the “Update interface icon” button on the right of the interface to enter the update interface interface.

• Delete the API

On the API interface management interface, click the “Delete Interface icon” button on the right of the interface to delete interface data.

• Update Mock Data In the Mock Data module of the Interface Details page, click the “Modify” button to the right of the Mock data list to modify Mock data.

• Delete Mock data

In the Mock Data module of the Interface Details page, click the “Delete” button to the right of the Mock data list to delete the Mock data.

• Running Mock data

In the Mock Data module of the Interface Details page, click the Run button to the right of the Mock data list to run the Mock data. The system will generate a unique Mock connection for each piece of Mock data. Accessing this connection will return Mock data in the corresponding format based on the data type set, such as JSON, as shown in the figure below.

• Save Test history

In the “interface test interface”, after the interface test, click the “save” button below will save the test data (interface URL, test parameters and other information). You can view all interface Test history records in the “Test History “module of the” Interface Details page “. Click the “Run” button on the right of a test record, it will enter the interface test interface corresponding to the test record, and restore the test data used in the test at that time;

• Delete Test history

In the “Test History “module of the” Interface Details page “, click the “Delete” button on the right of the Test history record to delete this record;

Enter the user management interface, click the “+ Add User “button in the upper right corner to add user information.

User attributes:

Login account: the user's login account; Login password: user login password. User type: Common user: allows users to operate only public projects or private projects that have project permissions. Super administrator: has the operation rights of all projects. Real name: the user's real name;Copy the code

Enter the user management interface, click the “Delete” button on the right of the user in the user list page to delete the user information;

• 1, extreme simplicity: simple interaction, one minute to get started;
• 2. Project isolation: API separates and isolates the project as a dimension;
• 3. Group management: API in a single project supports user-defined group management;
• 4, mark stars: support to mark API stars, after marking priority display;
• 5. API management: create, update and delete APIS;
• 6, PERFECT API properties: support to set rich API properties such as: API status, request method, request URL, request header, request parameters, response result, response result format, response result parameters, API remarks and so on;
• 7. Markdown: Support to add remarks in MarkDown format for API;
• 8. Mock: Support to define Mock data for API and formulate data response format, so as to quickly provide Mock interface and speed up development progress;
• 9. Online test: support online API test and save test data to provide interface test efficiency;

• 1. Project permissions: support setting permissions for projects. Only with permissions can you operate the API in the project;
• 2, API historical version: support to compare the historical version of API modification, version backtracking and other operations;

Xxl-api is hosted on Github, if you have any questions, please ask questions on ISSUES, or join the above technical exchange group;