# easy-docs

**Repository Path**: lwphk/easy-docs

## Basic Information

- **Project Name**: easy-docs
- **Description**: SpringBoot web项目生成文档工具
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2023-04-27
- **Last Updated**: 2025-01-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# easy-docs

#### 介绍
SpringBoot web项目生成文档工具

#### 软件架构
软件架构说明


#### 安装教程

1.  git clone https://gitee.com/lwphk/easy-docs.git
2.  cd easy-docs
3.  mvn install 

#### 使用说明

1. pom.xml 引入

    	<dependency>

		<groupId>com.lwphk.easydocs</groupId>

		<artifactId>easy-docs</artifactId>

		<version>0.0.1-SNAPSHOT</version>  </dependency> 

	




2.  application.properties

        easydocs.enable=true   #开启文档生成


3. [可选]

   在项目src/mian/resources目录下新建 

   easy-docs.txt  内容如下:
   
    [FieldMapping]

    #名称=备注      名称可以是方法名,参数名,实体类字段名,控制器类名 ,如果是控制器类名 / 将会转换成目录

    UserController=用户/基本功能

    register=用户注册

    username=用户名

    password=密码

    age=年龄

    email=邮箱地址

    birthday=出生年月

    [ExcludeParam]

    #排除控制器方法参数的类

    javax.servlet.HttpSession
    

4.  启动项目后访问  
        localhost:port/easy-docs.ui   

   
   ![输入图片说明](image.png)

    效果如下
    
   ![输入图片说明](WX20230506-110633@2x.png)
    

    
#### 后期功能
    加入JSR303解析,获取字段的验证项
    一键导出所有接口到postman