项目使用 JFinal 的时候没法使用 Swagger 去自动生成文档。

依靠注释配置的文档工具 apidoc 就非常适合

Java 方法注释

1
2
3
4
5
6
7
8
9
10
/**
* @api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id Users unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/

创建文档

1
apidoc

生成

官方文档