# nature-doc

**Repository Path**: mvilplss/nature-doc

## Basic Information

- **Project Name**: nature-doc
- **Description**: 用来生成类似swagger的测试api界面，与nature-framework完美结合的一个插件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: http://git.oschina.net/mvilplss/nature-doc
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2017-07-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# nature-doc
用来生成类似swagger的测试api界面,可以节省写api的时间和测试时间，

> 注意只对nature-framework1.0.5以上版本支持。

# 使用方法
### 简单配置
- 项目引入nature-doc.jar（毫无疑问）
- 将doc整个目录拷贝到项目的webapp下面（目前doc中只有个index.ftl）
- 项目中nature.properties中增加配置：nature.plugin=org.nature4j.DocInit

### 如何使用
- nature-doc提供了两个注解@DocTitle和@DocParam,分别标识Ctrl类的名称和方法的参数
- 如果没有标注则不会展示

### 使用示例

```

@DocTitle("角色管理")
@Ctrl(namespace = "/role")
public class RoleCtrl extends NatureCtrl {
    public NatureMap role;
    @Ask(url = "/list",type = AskType.GET)
    @DocMethod(params = "role.name=超级管理员&role.level=0",name = "测试方法")
    public Object list(){
        //TODO ... 业务
        return new JsonData(role);
    }
}

```

### 效果图
![效果图](https://git.oschina.net/uploads/images/2017/0715/220331_502fd166_347954.png "QQ截图20170715220409.png")