1. Project Overview

doc-apis is a truly zero-intrusion API documentation generation tool and one of the easiest API documentation generators to use worldwide. No additional lines of code or configuration are required, and there is no need to package it into your project. Simply add the Maven coordinates (GAV) to your project, click Start, and generate multilingual, internationalized API documentation for multiple platforms, including Web, iOS, and Android, within seconds. It also supports online debugging and many other powerful features.

2. Open Source License

Licensed under AGPL-3.0

3. Screenshots

Preview

4. Feature Overview

Advantages

• Zero Intrusion: Unlike frameworks such as Swagger, which require additional business code to generate documentation, doc-apis automatically generates API documentation as long as your code follows the required conventions.

• Zero Configuration: Spring Boot projects can automatically generate API documentation with as few as 0 lines of configuration. All settings are designed for ease of use and come with default values. Configure only what you need.

• Transparent Dependencies: After integration, it is completely transparent to the original project and has no impact on it. It does not even need to be packaged into the project, so there is no need to worry about additional risks from third-party dependencies.

• Agile Development: There is no need to implement the API first. Simply define the API request URL, request method, input parameters, and output parameters to generate documentation, allowing frontend and backend developers to start working quickly.

• Rich Content: Everything from request URLs and HTTP methods to request parameters and response data is included. All essential information, such as parameter types, whether parameters are required, and parameter descriptions, is clearly presented at a glance.

• Multiple Formats: Generate documentation in multiple formats, including HTML and MD, in one go. It supports various platforms, including Web, iOS, and Android, to accommodate different use cases.

• Broad Compatibility: Supports mainstream Spring Boot and Spring projects, as well as less common frameworks such as JFinal and Player.

• Powerful Features: Supports online debugging, multiple request methods, custom request headers, and more, providing an all-in-one solution for API documentation and API debugging.

• Multilingual Support: Supports generating API documentation in multiple languages. The user documentation is also available in both Chinese and English. Contributions in other languages are welcome.

• Excellent Compatibility: Compatible with JDK 8 through JDK 21. Supports Spring Boot versions 1.x through 3.x, as well as all versions of Spring, JFinal, and other supported projects.

• Code Standards: Monitors code quality at the source. It clearly identifies modules with missing code comments or API designs that do not follow RESTful conventions, encouraging developers to maintain consistent coding standards.

• Easy to Use: Even premium ingredients require only simple cooking, and a high-end documentation generation framework requires only simple operations. Go from beginner to proficient in just 0–5 minutes with lightning-fast onboarding.

• Continuous Updates: ...

5. Tech Stack

Maven:

<dependency>
    <groupId>com.doc-apis</groupId>
    <artifactId>doc-apis-starter</artifactId>
    <version>${Latest Version}</version>
</dependency>

Gradle:

compile group: 'com.doc-apis', name: 'doc-apis-starter', version: 'Latest Version'