# api-result

**Repository Path**: springside888/api-result

## Basic Information

- **Project Name**: api-result
- **Description**: API接口返回结果规范化解决方案
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://github.com/fengwenyi/api-result
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2022-04-05
- **Last Updated**: 2022-04-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">
    api-result
</h1>

<p align="center">
	<strong>`api-result` ，是一套RESTful风格API接口响应参数规范化的解决方案。</strong>
</p>


## 特性

- 规范化。
- 统一化。
- 标准化。


## 快速开始

### Maven

```xml
<dependency>
    <groupId>com.fengwenyi</groupId>
    <artifactId>api-result</artifactId>
    <version>2.5.3</version>
</dependency>
```

### 代码示例

```java
@RestController
@RequestMapping("/api")
public class ApiController {

    @RequestMapping("/demo")
    public ResponseTemplate<Void> demo() {
        return ResponseTemplate.success();
    }

}
```

### 请求

```shell
curl http://localhost:8080/api/demo
```

### 响应示例
```json
{
  "code":0,
  "message":"Success",
  "success":true
}
```

## 其他

- [文档](https://github.com/fengwenyi/api-result/wiki)
- [Maven仓库](https://mvnrepository.com/artifact/com.fengwenyi/api-result) 
- [更新日志](LOG.md)