Commit cba42dae by 李秋伟

Update README.md

parent 2099644d
# 介绍 - # 介绍
protocol-starter提供http、dubbo等协议封装 protocol-starter提供http、dubbo等协议封装
# 特点 # 特点
- 支持dubbo、http协议swagger文档 - 支持dubbo、http协议swagger文档
- 支持dubbo、http协议response异常统一处理 - 支持dubbo、http协议response异常统一处理
- 多语言处理 - 多语言处理
# 文档 # 文档
- [dubbo-spring-boot](https://github.com/apache/dubbo-spring-boot-project/blob/master/README_CN.md) - [dubbo-spring-boot](https://github.com/apache/dubbo-spring-boot-project/blob/master/README_CN.md)
- [swagger常用注解](https://www.jianshu.com/p/f30e0c646c63) - [swagger常用注解](https://www.jianshu.com/p/f30e0c646c63)
# 开始 # 开始
- 添加依赖 - 添加依赖
- Maven:需要在自己项目的pom.xml增加,以下配置。 - Maven:需要在自己项目的pom.xml增加,以下配置。
...@@ -33,11 +33,33 @@ protocol-starter提供http、dubbo等协议封装 ...@@ -33,11 +33,33 @@ protocol-starter提供http、dubbo等协议封装
</dependency> </dependency>
``` ```
# 示例 # 示例
- springMvc(略) - springMvc
- dubbo-swagger示例 **注意:使用ApiController注解**
```
@Api(value = "用户管理", tags = "用户管理", position = 3)
@ApiController(value = PathConstant.APPMS + "/user")
public class UserController {
/*
*根据id查询用户
* @Param id
* @return
* */
@GetMapping("/getById")
@ApiOperation(value = "根据id获取用户详细信息", notes = "根据id来获取用户详细信息")
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
public Object getById(Long id) {
return service.getById(id);
}
```
- dubbo-swagger示例
- User - User
...@@ -108,6 +130,6 @@ protocol-starter提供http、dubbo等协议封装 ...@@ -108,6 +130,6 @@ protocol-starter提供http、dubbo等协议封装
- 访问方式 - 访问方式
http://localhost:8080/doc.html http://localhost:8080/doc.html
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment