⛵Sponsor

Easy-Es

User-friendly,Lower code Elasticsearch Search Engine ORM Framework...

Mingdao-Cloud

Quickly respond to business needs, transforming from an 'IT scapegoat' into an 'IT hero'...

FastBee

An easy-to-use IoT platform,individual learning ...

- name: Easy-Es
  desc: User-friendly,Lower code Elasticsearch Search Engine ORM Framework...
  avatar: /img/sponsor/easy-es-logo.jpg
  link: https://www.easy-es.cn/
  bgColor: '#25c37d'
  textColor: '#FFFFFF'

- name: Mingdao-Cloud
  desc: Quickly respond to business needs, transforming from an 'IT scapegoat' into an 'IT hero'...
  avatar: /img/sponsor/mingdao-logo.jpg
  link: https://www.mingdao.com?s=utm_206&utm_source=doc-apis&utm_campaign=IT%E7%BD%91%E7%AB%99&utm_content=%E6%B3%A8%E5%86%8C%E4%BD%93%E9%AA%8C
  bgColor: '#25c37d'
  textColor: '#FFFFFF'

- name: FastBee
  desc: An easy-to-use IoT platform,individual learning ...
  avatar: /img/sponsor/fxwl-logo.gif
  link: https://fastbee.cn/
  bgColor: '#25c37d'
  textColor: '#FFFFFF'

become sponsor

🍬Advantages

• Zero Intrusion: Unlike frameworks like Swagger, there's no need to write additional business code for documentation generation. As long as your code adheres to the standards, API documentation is automatically created.
• Zero Configuration: With Spring Boot, zero lines of configuration are needed at a minimum to generate API documentation. All configurations are streamlined with default values, only requiring adjustments when necessary.
• Transparent Dependency: After integration, it remains completely transparent to the original project, causing no impact. It can even be excluded from project packaging, eliminating concerns about third-party dependencies introducing extra risks.
• Powerful Features: The generated documentation allows for direct online debugging, with all necessary debug information provided by default but also customizable, offering a superior experience to Swagger and Postman.
• Rich Content: Comprehensive details are included, ranging from request URLs, methods, input/output parameters, parameter types, mandatory fields, and descriptions, ensuring clarity.
• Versatile Output: Documentation can be generated in multiple formats such as HTML, MD, suitable for various scenarios including WEB, iOS, Android, etc.
• Broad Compatibility: Supports mainstream frameworks like SpringBoot, Spring, as well as niche ones like JFinal, Play, etc.
• Multilingual Support: Generates API documentation in multiple languages and provides bilingual (Chinese-English) user guides.
• Excellent Compatibility: Works across a wide range of Java Development Kits (JDK8 to JDK21) and SpringBoot versions (from 1.x to 3.x), among others.
• Ease of Use: Requires minimal learning, with most projects involving no additional learning costs. Even in exceptional cases, the learning curve is under 3 minutes.
• Affordable Pricing: Free for individual users and businesses with up to 10 employees. Larger enterprises incur a reasonable fee based on scale, aimed at sustainability rather than profit.

✨ Latest Version: (opens new window)

Springboot project

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'

Other project

        <dependency>
            <groupId>com.doc-apis</groupId>
            <artifactId>doc-apis-core</artifactId>
            <version>Latest Version</version>
        </dependency>

Gradle:

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

Is the version stable ?

Prior to each release, we ensure comprehensive test case coverage for every feature. Our unit tests boast an aggregate coverage rate exceeding 95%, with all deployed functionalities thoroughly tested. These tests have been validated through real-world usage in production environments and by a substantial user base within the open-source community.Moreover, we've conducted both theoretical analyses and practical tests to evaluate the framework's performance and security, guaranteeing peace of mind for all users. Detailed information on these aspects is available in the 'Shattering Concerns' section of our documentation.Our origins lie in the prestigious Aizuda open-source community, and our author is also a member of the Dromara open-source community, renowned for creating Easy-Es. With a wealth of development expertise, we take pride in the truly non-intrusive nature of our framework, which can be utilized without needing to be packaged into your project. Thus, you can confidently incorporate it into your workflow!"This response emphasizes the thorough testing and validation processes undergone by the framework, its performance and security assurances, the credibility of its creators, and its non-intrusive integration capabilities, providing assurance to potential users regarding its reliability and ease of use!

🏡Code Hosting

💪🏻PR

We welcome all heroes to join us in improving doc-apis. We look forward to your PR!

If you wish to contribute, please first reviewPR。

🧲Links