Swagger 无法生成 HTTP“PATCH”的文档

2024-04-15

我已遵循以下内容
博客条目:http://kingsfleet.blogspot.co.uk/2014/02/transparent-patch-support-in-jax-rs-20.html http://Transparent%20PATCH%20support%20in%20JAX-RS%202.0
https://github.com/jersey/jersey/tree/2.6/examples/http-patch http://Sample%20Http%20Patch%20in%20jersey
创建端点以支持 Jersey 2.6 中的 HTTP“PATCH”方法 依赖版本:

-Jersey: 2.6
-swagger-jersey2-jaxrs_2.10: 1.3.12

问题? Why Patch终点没有被列为 swagger ui 文档的一部分?

分析:

如果我使用此注释进行注释,则会生成该端点的文档,但没有交互。

@com.wordnik.swagger.jaxrs.PATCH

配置

JerssyApplicationInitializer

packages(true, "com.test.account.endpoint", "com.wordnik.swagger.jaxrs.json");
        //Swagger Configuration
        register(new ApiListingResourceJSON(), 10);
        register(JerseyApiDeclarationProvider.class);
        register(JerseyResourceListingProvider.class);

        //Genson Converter
        register(GensonJsonConverter.class, 1);
        register(createMoxyJsonResolver());

我不确定,如果我遗漏了什么,任何帮助或指南都会有帮助。

补丁方法文档:

 public static final String PATCH_MEDIA_TYPE = "application/json-patch+json";
    @PATCH
        //@com.wordnik.swagger.jaxrs.PATCH
        @PreAuthorize(userAuthenticationRequire=true)
        @Consumes(PATCH_MEDIA_TYPE)
        @Path("{id: .\\d+}")
        @ApiOperation(value = "Update Client Details in UIM System."
                    , response = State.class
                    , notes="Requesting User, should be the owner of the Client."
                    , consumes = PATCH_MEDIA_TYPE)
        @ApiResponses({
            @ApiResponse(code = _401, message = "If the access token is invalid.", response = String.class),
            @ApiResponse(code = _498, message = "If the access token is expired.", response = String.class),
            @ApiResponse(code = _420, message = "If Provided Input is not valid according to requirment specification."),
            @ApiResponse(code = _404, message = "If no client/app Found."),
            @ApiResponse(code = _200, message = "If Client Account has been Updated successfully. ", response=String.class)
        })
        public State updateClientDetails(@ApiParam(value="Client Id to be Updated.", required=true) @PathParam(CLIENT_ID) String clientId
                , @ApiParam(value = "Updated field and Value.", required = true) final State newState){
            //LOG.info("[ENTRY]- Received requst for updating Client {} from System.", clientId);
            System.out.println("----->" + someBean.test());
            //LOG.info("[EXIT]- Client Id {} Updation has been completed.", clientId);
            Test t = new Test();
            t.name = "Hello Test";
            System.out.println(t.name);
            return newState;
        }

看看你的index.html。通过将其更改为以下内容,可以控制哪些 HTTP 操作是交互式的:

  window.swaggerUi = new SwaggerUi({
    url: url,
    dom_id: "swagger-ui-container",
    supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],

您将在 PATCH 方法上进行交互:

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Swagger 无法生成 HTTP“PATCH”的文档 的相关文章

随机推荐

  • 有没有办法告诉 Chrome 密码生成器网站密码政策?

    从我迄今为止的测试来看 Chrome 密码生成器仅生成包含大写字母 小写字母和数字的密码 但似乎不使用特殊字符 如果我正在构建一个网站 该网站的密码策略需要至少一个特殊字符 是否有一种方法可以让 chrome 意识到这一策略 以便密码生成器
  • 在 Xcode 中添加 Firebase 时如何解决“重复符号”

    我无法解决 重复符号 错误 错误是 duplicate symbol GSDK NSClassFromString in Pods FirebaseCore Frameworks FirebaseCore framework Firebas
  • pymssql:执行许多值错误 - 需要一个简单类型、元组或列表

    grpidx data for i in range 0 len data1 grpidx data append data1 loc i price data1 loc i id cur executemany insert into g
  • 摇动:发出是否需要重建任何东西的信号

    我使用 shake 构建了一堆静态网页 然后我必须使用 sftp 将其上传到远程主机 目前 cronjob 运行 git pull get possibly updated sources my shake system lftp uplo
  • org.w3c.dom.Document 转换为字符串,无需 javax.xml.transform

    我花了一段时间在 Google 上寻找一种将 org w3c dom Document 转换为整个 DOM 树的字符串表示形式的方法 这样我就可以将对象保存到文件系统中 然而 我发现的所有解决方案都使用 javax xml transfor
  • KubernetesExternalName服务在DNS中不可见

    我正在尝试将单个数据库实例公开为两个 Kubernetes 命名空间中的服务 Kubernetes 版本 1 11 3 在 Ubuntu 16 04 1 上运行 数据库服务是可见的并且在默认命名空间中工作 我在非默认命名空间中创建了一个Ex
  • 打造 ecto 独一无二的领域

    如何制作一个字段unique在体外 我以为它和Ruby中的活动记录一样 但似乎不是 你想使用唯一约束 3 http hexdocs pm ecto Ecto Changeset html unique constraint 3 这与 Act
  • 如果 MySQL 中的行不存在,则添加到该行

    当向表中添加一行时 但首先检查它是否存在哪种处理方法最有效 是否是查询是否存在的情况 如果不存在则插入 或者重复使用 或者简单地替换 如果该行不存在 这会起作用 吗 Thanks 我认为这是 MySQL 中最快的方法 REPLACE int
  • 不可变类型:公共最终字段与 getter

    我需要一个小的容器类来存储一些应该不可变的字符串 由于 String 本身是不可变类型 所以我想到了类似的东西 public final class Immu public final String foo public final Str
  • 从 airodump-ng 读取实时输出

    当我执行命令 airodump ng mon0 gt gt output txt 时 output txt 为空 我需要能够运行 airodump ng mon0 并在大约 5 秒后停止该命令 然后才能访问其输出 有什么想法我应该从哪里开始
  • 如何以良好的格式结果格式化 python 列表

    我有很多列表 如下所示 通过打印data并将其与字符串连接起来check str如下最后一条语句所示 需要帮助以在字符串连接后更好地格式化列表值 如预期所示 print data printing lists in this variabl
  • 图像上的文本没有绝对位置

    我正在尝试在页面中间的图像上放置一些文本 我看到一个这样的例子 img src image png p p p p
  • 在 docker 容器上保存配置

    我创建了 2 个 docker 容器 并尝试在 ubuntu debian 上安装一些应用程序和一些软件包 如 mc ping traceroute 但每当我退出容器时 我都会丢失其中的所有内容 是否有任何 docker 命令可以保存我的配
  • 从具有特定模式的 txt 文件创建 Pandas DataFrame

    我需要基于以下结构的文本文件创建一个 Pandas DataFrame Alabama edit Auburn Auburn University 1 Florence University of North Alabama Jackson
  • .NET Framework 全局程序集缓存在哪里?

    我安装了 VS2010 和 NET 4 0 然后编译了一个程序集并使用可用的 exe 运行 gacutil ProgramFiles Microsoft SDKs Windows v7 0A Bin NETFX 4 0 Tools 可执行文
  • 如何在 R 中重新格式化表格?

    我加载了一个这样的表 V1 V2 V3 pat1 1 2 pat1 3 1 pat1 4 2 pat2 3 3 pat3 1 4 pat3 2 3 我需要将其格式化为如下所示 其中 V1 表示行 V2 表示列 V3 中的值 1 2 3 4
  • Android 中未接来电的广播接收器

    有谁知道未接来电的意图是什么 实际上 我想在我的应用程序中发送有关未接来电和来电的短信 您需要使用 ContentObserver public class MissedCallsContentObserver extends Conten
  • fork 后调试子进程(配置了 follow-fork-mode 子进程)

    我正在开发一个应用程序 父级分叉子级来处理某些任务 我遇到一个问题 我已将 gdb 配置为 follow fork mode 子级 但在 fork 后 到达断点后 它发送 SIGTRAP 但子级以某种方式终止并向父级发送 SIGCHLD 我
  • 数据表行切换选项

    我的问题 我正在开发一个与 DataTableJS 相关的项目 我需要一个行分组功能 它与分组行分开 只是我想在下面的切换中显示相关的表行内容城市名 我到底在寻找什么 我的演示代码 document ready function var t
  • Swagger 无法生成 HTTP“PATCH”的文档

    我已遵循以下内容博客条目 http kingsfleet blogspot co uk 2014 02 transparent patch support in jax rs 20 html http Transparent 20PATCH