Skip to main content

OpenAPI Specification File

If you need to use the OpenAPI specification file for API integration development or tool import, you can download the complete OpenAPI definition file from the following address: Download URL:
https://raw.githubusercontent.com/ichaozai/docflow-docs/refs/heads/master/docflow/en/rest-api/openapi.yaml

Usage Guide

The downloaded OpenAPI file (YAML format) contains the complete interface definition of DocFlow API. You can:
  1. Import into API Development Tools: Such as Postman, Insomnia, Apifox, etc., to quickly generate API request collections
  2. Generate Client Code: Use tools like OpenAPI Generator to automatically generate SDK code for various programming languages
  3. View Complete API Documentation: View detailed interface descriptions in documentation tools that support OpenAPI specifications

File Contents

The file includes:
  • Detailed definitions of all API endpoints
  • Request parameters and response format descriptions
  • Data models and structure definitions
  • Authentication method descriptions
  • Sample code for interfaces
If you have any questions, please feel free to contact our technical support team.