# restfulDoc

**Repository Path**: heliteng/restfulDoc

## Basic Information

- **Project Name**: restfulDoc
- **Description**: restful 文档生成工具，支持在线测试
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-04-05
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#restfulDoc
restful 接口文档生成利器 restfulDoc

restfulDoc是基于JAVA开发的，针对主流web框架做的接口文档生成利器，只需极简配置就可以实现文档的生成，且对项目零入侵，主要目的是解决协作开发中接口文档及时更新。

restfulDoc有如下主要特点

1.简单易用，配置极简

2.对项目零入侵，在不改变项目本身代码结构上加上restfulDoc的格式注解就可以快速生成文档，只对Controller层解析

## restfulDoc使用

#### 1、maven包依赖,javadoc.jar在工程lib目录下
```
<dependency>
    <groupId>org.doc</groupId>
    <artifactId>restful-doc</artifactId>
    <version>1.0.3</version>
</dependency>
```



#### 2、Controller中，方法注释

```
     /**
     * #DOC#
     * 我是测试接口
     * @title 测试接口
     * @param username|用户名|String|必填|张三
     * @respParam registerStatus|注册状态|Integer|必填
     * @respBody {registerStatus:1}
     */
```

`#DOC# 表示该注释使用文档生成，必须单独一行`

`@title 接口标题 `

`@param为请求参数 可设置多个，依次表示： 参数名 描述 请求类型 是否必填 默认值 `

`@respParam返回参数,可设置多个，依次表示： 参数名 描述 请求类型 是否必填  `

`@respBody返回demo `

#### 3、添加restful-doc.properties 配置文件
```
#项目地址
project.root=E:/workspace/projectName
#指定java文件路径
java.source=src/main/java
#指定需要生成文档的包路径
package.name=com.app.controller
#指定采用的框架类型,目前springmvc
parser.name=springmvc
#指定文档输出路径
out.path=E:/workspace/projectName/src/main/webapp/api.html
#指定模版生成器，目前仅支持html
parser.formater=html

```


#### SpringMVC，SpringBoot框架中调用

```
package com.app;

import org.doc.core.api.springmvc.SpringMVCApiDocConfig;

public class SpringDocBuilder {

    public static void main(String[] args) {
        SpringMVCApiDocConfig doc = new SpringMVCApiDocConfig();
        doc.setConfigFilePath("restful-doc.properties");
        doc.start();
    }
}

```

####联系我
[![联系何立腾](http://wpa.qq.com/pa?p=2:185656746:51 "联系何立腾")](http://wpa.qq.com/msgrd?v=3&uin=185656746&site=qq&menu=yes)