flmn / http-api-demo

一个演示使用 Spring Boot 实现 HTTP API 的例子

HTTP API Demo

一个演示使用 Spring Boot 实现 HTTP API 的例子。1.0 版 PPT 在工程 doc 目录里。持续更新的在线版地址：HTTP 接口设计

相关文章：

• 分享开发多个线上项目后总结的 HTTP 接口设计方案
• 如何做 HTTP 接口的访问控制
• 为 HTTP API 接口增加统一请求日志

运行方法

运行如下命令，编译运行 demo。

git clone https://github.com/flmn/http-api-demo.git
cd http-api-demo
./gradlew build
build/libs/http-api-demo-1.2.0.jar

开发说明

在项目目录运行如下命令，生成 Idea 工程文件。

./gradlew idea

用 Idea 打开 http-api-demo.ipr 工程文件。

!注意事项!

1.1.0 版本增加了使用 redis 保存 session，请确保在 localhost 的 6379 端口运行着 redis，并且没密码。修改配置请参见 config/application.yml 配置文件。

否则项目运行会出错。

更多信息

• 请关注公众号: architect-xnq

• 或者添加私人微信: pisystem

http-api-demo's Issues

fix: api UpdateDocument

https://github.com/flmn/http-api-demo/blob/master/src/main/java/tech/jitao/httpapidemo/api/web/document/UpdateDocument.java
缺少 RestController 注解

一个接口对应一个controller 会不会导致 controller 爆炸式增长呀

你好，看了你的文章，很有收获，但是如题所说，一个接口对应一个controller 会不会导致 controller 类太多，个人感觉 controller 是否可以以模块为维度，而不是操作为维度

如何处理多端接口相同的问题？

1. 每个接口一个类，是否导致类过多？
2. 例如app端和web端都需要获取用户列表，按照项目描述，分别定义url和实现类为:

• /api/app/user/list & api.app.user.List
• /api/web/user/list & api.web.user.List

接口执行的逻辑和返回的数据格式完全一致，两个类除了包路径不同其他完全相同，存在代码冗余的问题