# doc-apis

**Repository Path**: lxc182114/doc-apis

## Basic Information

- **Project Name**: doc-apis
- **Description**: 零侵入,零代码,接口文档一键生成框架,可一次性生成Web,IOS,Android多端接口文档,支持html,markdown等多种格式,可支持多种语言及在线调试
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: https://www.doc-apis.com/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 40
- **Created**: 2024-10-11
- **Last Updated**: 2024-10-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <a href="https://en.doc-apis.com/">
   <img alt="Doc-Apis-Logo" src="https://iknow.hs.net/e21b7ba1-949f-499d-8c29-2b3eb2ec3fd4.png">
  </a>
</p>

<p align="center">
  Zero-intrusive, zero-code interface documentation auto-generation and one-click debugging framework.
</p>

<p align="center">
  <a href="https://search.maven.org/search?q=g:com.doc-apis%20a:*">
    <img alt="maven" src="https://img.shields.io/github/v/release/xpc1024/doc-apis?include_prereleases&logo=xpc&style=plastic">
  </a>
  <a href="https://www.apache.org/licenses/LICENSE-2.0">
    <img alt="code style" src="https://img.shields.io/badge/license-Apache%202.0-4EB1BA.svg?style=flat-square">
  </a>
  <a href="https://www.gnu.org/licenses/agpl-3.0.html">
    <img alt="code style" src="https://img.shields.io/badge/license-AGPL 3.0%20-4EB1BA.svg?style=flat-square">
  </a>
</p>

## What is Doc-Apis?
---

A foolproof, non-intrusive, code-free framework for automatic generation of API documentation with one-click debugging.

## Official website
---

**doc-apis website**  https://en.doc-apis.com/

**dic-apis github** https://github.com/aizuda/doc-apis

**dic-apis gitee** https://gitee.com/aizuda/doc-apis


**aizuda website** https://aizuda.com/home


**aizuda gitee homepage** https://gitee.com/aizuda


**dromara website** https://dromara.org/


**dromara gitee homepage** https://gitee.com/dromara/



## Links
---
- [中文版](https://gitee.com/easy-es/doc-apis/blob/master/README.md)
- [Samples](https://github.com/xpc1024/doc-apis/tree/main/doc-apis-test)
- [Demo in Springboot](https://en.easy-es.cn/pages/658abb/#_2-pom)

## Features
---

- **Zero Intrusion:** Unlike frameworks like Swagger, which require additional business code to generate documentation, doc-apis generates API documentation automatically as long as your code complies with standards.
- **Zero Configuration:** For Springboot projects, it takes as few as 0 lines of configuration to automatically generate API documentation. All configurations are designed for ease of use and come with default values, allowing you to configure as needed.
- **Transparent Dependency:** After introduction, it remains completely transparent to the original project without any impact. There's no need to worry about extra risks brought about by introducing third-party dependencies since it doesn't even need to be packaged into the project.
- **Agile Development:** No need to implement the interface; merely define the URL, type, and input/output parameters of the request to generate documentation, facilitating swift development for both front-end and back-end teams.
- **Rich Content:** From request URLs to methods, input and output parameters, all necessary information such as parameter types, mandatory status, and descriptions are clearly presented.
- **Diverse Formats:** Generates various formats such as HTML and MD in one go, simultaneously compatible with WEB, iOS, Android, and other types, adapting to various scenarios.
- **Broad Compatibility:** Whether it's mainstream SpringBoot projects, Spring projects, or niche Jfinal, Play frameworks, etc., compatibility is assured.
- **Powerful Features:**  Supports online debugging, multiple request methods, custom headers, and more, covering all your needs for API documentation and testing in one place.
- **Multi-language** Generates multi-lingual API documentation, with user documentation currently supporting Chinese and English. Contributions for other languages are welcome.
- **Good Compatibility:** Works well with JDK versions from 8 to 21, and SpringBoot from 1.x to 3.x. Compatibility is ensured across all versions for Spring, Jfinal, and other projects.
- **Code Conformity:** Monitors code quality from the source. Unannotated modules and non-Restful style interfaces are clearly identified, encouraging developers to standardize their code.
- **Ease of Use:** Like high-quality ingredients requiring simple cooking, a sophisticated documentation generation framework requires simple operations. From beginner to expert, you can master it in 0 to 5 minutes.
- **Continuous Updates:** ...
-   ...


## Preview
---

![1](https://iknow.hs.net/0b2727a5-b7a7-4322-91dd-d19768003254.png)
![2](https://iknow.hs.net/debe308b-01fc-4458-887b-281f2ff44cb0.png)
![3](https://iknow.hs.net/d711a56e-7733-4b25-8773-0a8b31f57d90.png)
![4](https://iknow.hs.net/1899397e-2122-4dec-a2c6-8ad4940f12cd.png)


## Advertising provider
---

<a href="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
">
  <img alt="ad" src="https://iknow.hs.net/00b4a54c-6505-4776-9232-f0a9d9768fac.jpg">
</a>

</br>

<a href="https://fastbee.cn/">
  <img alt="ad" src="https://iknow.hs.net/b0592c71-5a41-427e-8d47-fcba4b399d02.png">
</a>

<br/>

## Donate
---
[Donate doc-apis](https://en.doc-apis.com/pages/fb599d/)


## License
---

Doc-apis is under the Apache 2.0 license and AGPL-3.0 license.