问题标签 [springfox]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
java - 使用 Springfox 在 Swagger UI 中的超媒体链接
我正在构建一个 RESTful API,使用 spring-hateoas 库来实现超媒体。我的端点的响应是 application/hal+json(我的 DTO 扩展了 ResourceSupport)。
我使用 Swagger 记录端点,并使用 Springfox 自动生成 swagger-ui。
问题是,生成的文档不正确。
作为对 POST 端点的请求,UI 将我的 DTO 中的 _links 部分设置为有效负载的一部分,所以这就是我认为应该作为 POST 端点的参数发送的内容:
所以我的问题是:有什么方法可以让 springfox 知道 application/hal+json 作为 Parameter 内容类型?如果没有,有没有办法从请求中隐藏 _links 部分?
java - Springfox 可以为同一个类生成不同的定义吗?
我一直在我的一个项目中使用 Springfox-swagger2:2.3.2 和 Springfox-swagger-ui:2.3.1 并且遇到了问题。
该项目采用 JSON HAL 标准的 Spring Boot 4.2.4。
基本上,我们对 POST 正文和响应正文使用相同的资源类。由于是 HAL,因此该资源具有链接和嵌入字段。在 POST 定义中,我们不需要链接和嵌入字段,但它们应该存在于响应定义中。
Springfox 是否可以生成此资源的不同定义,以便 POST 模型模式不包含链接和嵌入字段?我不想为使用的每个上下文创建相同资源的不同类。我尝试在 @ApiModelProperty 注释中使用“隐藏”属性,但最终从响应模型架构中删除了链接和嵌入字段。
spring - 如何用 swagger 自定义 api spec 中生成的 operationId 的值?
我已经使用 springfox 2.0 配置了我的 spring 项目。我能够用它生成开放的 api 规范。
如您所见, operationId 的值是格式
前任。getPetsUsingGET
此 operationId 在使用 swagger-codegen 生成客户端时使用。有谁知道如何定制它?我知道这可以通过使用每个 api 来完成,@ApiOperation
但是有没有更通用的方法来为所有 api 定义这种格式?
spring - springboot,springfox,不止一个API
我有一个带有 Springboot (1.3.0)、Springfox-swagger2 (2.2.2) 和 Springfox-swagger-ui (2.2.2) 的应用程序。我已经配置了两个 API,其中一个在某些路径(/my-root/internal.*)和其他路径(/my-root/external.*)中显示某些服务的文档。
我的问题是我在“内部。*”中的一个服务和“外部。*”中的一个服务之间共享一个 ApiModel(让我们说“事务”),我想在内部 api 文档中显示“事务”的属性但是隐藏在外部 api 文档中。
你知道我该怎么做吗?
提前致谢!
spring - 如何在spring-mvc中为springfox(更准确的springfox-swagger2)设置主机url?
我有 spring-mvc 应用程序,并且我已经嵌入了 RestAPI。一切正常,我的 rest api 映射在/rest/*
url 上。当我添加 SwaggerConfig 时,它已经开始识别我的控制器,但是当我在 swagger-ui 中尝试它时(用于简化消费者与 api 交互的 gui 形式)
我有 404 not found 状态。因为这在 这个没有对有效网址的请求上进行了尝试
虽然 SwaggerConfig 映射到正确的 url,因为我在写的时候有这个 GUI 表示
根 url 上有一个应用程序的主要部分(这不是我工作的部分)我的部分映射到/rest/*
我如何也可以更改这个“试用”url /rest/*
?我的 Swagger 配置
我也指定了这个
对不起我的英语不好,提前谢谢
swagger-2.0 - springfox 招摇 Json 错误
我是新来的。我有以下代码:
这是我得到的 json 的一部分:
我无法弄清楚Json有两个问题:
- 我有两个 openTask 接口,一个 GET 和一个 POST,但招摇的 Json 只包括 POST 一个。
- 对于某些接口,我得到 "schema":{"$ref":"#/definitions/Error"} 的 500 响应,但我没有这个模式,我不明白为什么我只得到它一些服务。我定义错了什么?谢谢,尼尔