# PanApiDoc

**Repository Path**: guo-dingyi/pan-api-doc

## Basic Information

- **Project Name**: PanApiDoc
- **Description**: PanApiDoc项目实现的一个对SpringBoot项目的接口Controller类进行扫描，并获取其信息，生成接口文档的项目
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-19
- **Last Updated**: 2024-07-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java

## README

# PanApiDoc（dev）

#### 介绍

PanApiDoc 是一个用 java 语言实现的生成Spring项目web后端接口文档的项目

#### 软件架构

软件架构说明


![输入图片说明](picture/DataStreamDesignPicture.jpg)

#### 安装教程

1. 把项目 clone 到本地
2. 使用maven工具对项目进行编译
3. maven install 到本地的maven仓库
4. 在另一个Maven项目中添加依赖

```xml

<dependency>
    <groupId>com.pan</groupId>
    <artifactId>PanApiDoc</artifactId>
    <version>1.0</version>
</dependency>
```

#### 快速开始

从Spring的ApplicationContext中获取bean交个PanApiDoc

```java

public class Application {
    public static void main(String[] args) {
        Object[] beans;//get beans
        PanApiDoc.run(beans);
    }
}

```   

然后就会在项目的根目录生成PanDoc文件夹生成对应的Api文档  
（现在暂时只能生成markdown文档）




#### 生成效果

一个简单的接口例子
```java
@PanComment("Pan Pan Pān-QíĀn: Test Class  Controller 测试")
@Controller
@RestController
@RequestMapping({"prefix", "prefix2", "prefix3"})
public class TestClass {

    @PanComment("测试test comment method 00") 
    @PostMapping("url/m00/{aaa}") 
    @ResponseBody
    public Result testMethod00(@PanComment("测试 aaa") @PathVariable("aaa") String aaa,
            @RequestParam("name") String name,
            @RequestBody @PanComment("测试 测试 body") Student student) {
        return new Result<>(200,"success",null);
    }

    @PanComment("测试test comment method 01")
    @RequestMapping("url/m01/{aaa}")
    @ResponseBody
    public Result testMethod01(@PanComment("测试 aaa") @PathVariable("aaa") String aaa,
            @RequestParam("name") String name,
            @RequestBody @PanComment("测试 测试 body") Student student) {
        return new Result<>(403,"fail",null);
    }
    
    @PanComment("测试test comment method 02")
    @GetMapping("url/m02")
    @ResponseBody
    public Result testMethod02(@RequestParam("name") @PanComment("潘潘潘") String name) {
        return new Result<>(403,"fail",null);
    }
}
```
生成的Markdown效果
![输入图片说明](picture/result.jpg)

#### 参与贡献

#### 特技