我想知道 Swagger 中是否有一个选项可以授权对包含外部文档的 url 的请求。
我有以下配置,我感兴趣的是urls[1]
part
springdoc.swagger-ui.urls[0].url=/v3/api-docs
springdoc.swagger-ui.urls[0].name=default
springdoc.swagger-ui.urls[1].url=https://asdasd.blob.core.windows.net/my-api/docs.spec
springdoc.swagger-ui.urls[1].name=additional
我可以从服务器(直接从机器上curl)访问文档,但是从Swagger(因此浏览器)我不能。我想知道是否有一个选项可以添加例如。Authorization Bearer xxxx
对此请求或实际上使服务器发出请求,而不是客户端。
To clarify - I want to fetch second file with OpenAPI definition from the remote server so I am talking about this:
Not the Authorize
part
我实施的解决方案:
海伦指出的可行 - 拦截请求并添加标头 - 但不幸的是,在我的情况下,还存在与存储的防火墙设置有关的问题。只有来自服务器的流量,而不是客户端(浏览器)通过,所以我:
- 将 url 设置为我的域中的某个内容
springdoc.swagger-ui.urls[1].url=v3/api-docs/additional
- 为远程主机的 url 指定另一个属性
mydomain.swagger-ui.additionalDocsUrl=...
- 实现了一个处理该 url 的自定义控制器 - 它作为服务器而不是客户端从远程获取 json,以便防火墙传递该请求
@Hidden
@RestController
@RequestMapping("/v3/api-docs/additional")
@RequiredArgsConstructor
public class AdditionalOpenApiController {
@Value("${mydomain.swagger-ui.additionalDocsUrl}")
private String additionalDocsUrl;
@Cacheable(value = "ADDITIONAL_API_DOCS", unless = "#result != null")
@GetMapping(produces = "application/json")
public String getAdditionalDocs() {
// in my case remote produces application/octet-stream so it needs to be byte[]
return Optional.ofNullable(new RestTemplate().getForObject(additionalDocsUrl, byte[].class))
.map(String::new)
.orElseThrow(() -> new ResourceNotFoundException("Cannot load Additional OpenAPI from storage"));
}
这只能通过编程来实现。
- 第一:实现你自己的
requestInterceptor
: 参见抽象SwaggerIndexTransformer https://github.com/springdoc/springdoc-openapi/blob/master/springdoc-openapi-common/src/main/java/org/springdoc/ui/AbstractSwaggerIndexTransformer.java以编程方式实现您的请求的示例(例如 addCSRF 方法)。
- Second Implement your own
MySwaggerIndexPageTransformer
and define it as a spring bean and it will be loaded instead of the springdoc SwaggerIndexPageTransformer
.
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)