java - GAE 的 ReSTLet Swagger 扩展使用指南

Question

我尝试采用类似的方法:

public Restlet createInboundRoot() {
        Router apiRouter = createApiRouter();
        attachSwaggerSpecificationRestlet(apiRouter, "/api-docs");
        return apiRouter;
}

当访问 /api-docs 时，ReSTLet 会抛出错误 404，这可能会造成困惑。这个想法是，当我们访问 /stuff 等资源时，我们拥有的 apiRouter 在这种状态下完全工作。

这段代码中可能缺少什么？或者在使用 GAE 的 ReSTLet Swagger 扩展时有什么具体注意事项需要考虑吗？

Answer 1

我测试了您的用例，我可以使用以下 Maven 配置 (reSTLet-version = 2.3.1)AE 开发服务器来使用 Swagger 扩展:

<dependencies>
    <dependency>
        <groupId>org.restlet.gae</groupId>
        <artifactId>org.restlet</artifactId>
        <version>${restlet-version}</version>
    </dependency>

    <dependency>
        <groupId>org.restlet.gae</groupId>
        <artifactId>org.restlet.ext.servlet</artifactId>
        <version>${restlet-version}</version>
    </dependency>

    <dependency>
        <groupId>org.restlet.gae</groupId>
        <artifactId>org.restlet.ext.swagger</artifactId>
        <version>${restlet-version}</version>
        <exclusions>
            <exclusion>
                <groupId>org.raml</groupId>
                <artifactId>raml-parser</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

    <dependency>
        <groupId>org.restlet.jse</groupId>
        <artifactId>org.restlet.ext.jetty</artifactId>
        <version>${restlet-version}</version>
    </dependency>
</dependencies>

您可以注意到，我必须在 ext.swagger 中排除 RAML 解析器。

这是我的 ReSTLet 应用程序的代码:

public class RestletApplication extends SwaggerApplication {
    @Override
    public Restlet createInboundRoot() {
        Router router = new Router(getContext());

        router.attach("/ping", MyServerResource.class);
        attachSwaggerSpecificationRestlet(router, "/docs");

        return router;
    }
}

如果它可以帮助您，我可以在 Github 存储库中提供我的测试项目。

希望对你有帮助