API Documentation

RuoYi AI documentation

This guide covers RuoYi AI. Report documentation problems through an issue.

Browse and import API definitions

Open the Springdoc definition

After starting the backend, open the local OpenAPI definition, using your actual port if different. The project uses Springdoc without starter-webmvc-ui, so this endpoint returns JSON rather than an interactive Swagger UI.

Import into Apifox

1. Open Apifox and create a project.

2. Open Project Settings → Import Data, select URL import, and enter http://localhost:6039/v3/api-docs.

3. Confirm the import.

4. Browse the imported endpoints.