如何为通过 Sparkjava 构建的 API 创建 API 文档？

编程问答 2022-05-27

问题描述

我正在构建一个 Java 应用程序，它使用 REST API 的“spark java”框架。这是一个很好的简单框架。但我需要创建自动生成的文档。我发现 Swagger 是一件好事。我已经在我的 Spring Boot 应用程序中使用了它。我找到了这篇文章：

Swagger and Spark Java integration

它有效。但有一个问题。我的项目中没有任何依赖注入。在本文中使用了这种结构：

@Api
@Path("/user")
@Produces("application/JSON")
public class createuserRoute implements Route {

    @POST
    @ApiOperation(value = "Creates a new user",nickname="createuserRoute")
    @ApiImplicitParams({ //
            @ApiImplicitParam(required = true,dataType="string",name="auth",paramType = "header"),//
            @ApiImplicitParam(required = true,dataType = "ro.serol.spark_swagger.route.request.createuserRequest",paramType = "body") //
    }) //
    @ApiResponses(value = { //
            @ApiResponse(code = 200,message = "Success",response=User.class),//
            @ApiResponse(code = 400,message = "Invalid input data",response=ApiError.class),//
            @ApiResponse(code = 401,message = "Unauthorized",//
            @ApiResponse(code = 404,message = "User not found",response=ApiError.class) //
    })
    public User handle(@ApiParam(hidden=true) Request request,@ApiParam(hidden=true)Response response) throws Exception {
        return new User();
    }

}

Authour 只返回 new User();

他使用反射来创建火花路由（RouteBuilder）。但是当我使用服务时它不起作用。或者它可能过于复杂（通过反射向 Route 注入服务）。

我的问题：

  1. 如何解决这个困境（注入）并使用 spark java + swagger？
  2. 有人可以分享更好的文章/解决方案来为 Spark java 创建 API 文档吗？

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）

javajavaspark-javaswaggerswagger