0

我们有一个正在运行的 Redoc 服务器，其中包括一堆带有 api 规范的 yaml 文件。但是，一些必要的 yaml 文件不在本地（我们称之为RedocServer）机器上。

这些远程文件可通过 aspnet-webapi 服务 ( WebApiServer ) 访问。

因此，假设要获取其中一个文件，我们在 index.yaml 文件中使用引用：

paths: 
  /api/1:
    $ref: "https:/some-address/ApiDoc.yaml"

如果 ApiDoc.yaml 本身没有引用，那么WebApiServer使用如下方法简单地返回一个字符串是没有问题的：

[HttpGet]
public string GetApiDoc()
{
      var directoryPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
      var filePath = Path.Combine(directoryPath, "ApiDoc.yaml");
      return File.ReadAllText(filePath);
}

然而，在我们的例子中，ApiDoc.yaml有一些巨大的、嵌套的对其中另一个文件的引用。类似的东西，暗示被引用的对象内部有引用：

post:
  tags:
    - Test
  summary: Test
  operationId: Test
  consumes:
  - application/json
  produces:
  - application/json
  requestBody:
    content:
      application/json:
        schema:
          $ref: "../ApiDoc2.yaml#/components/schemas/ApiRequest"
  responses:
    200:
      description: OK
      content:
        application/json:
          schema:
            $ref: "../ApiDoc3.yaml#/components/schemas/ApiResponse"

如果WebApiServer返回类似的字符串，RedocServer可能会尝试使用RedocServer文件解析这些引用。但我们显然希望确保在WebApiServer端解析引用。

所以，问题是，如何在不破坏任何引用的情况下正确返回该 ApiDoc.yaml？

我们无法手动解析引用，因为对象很大且嵌套很深。我们尝试使用的 OpenApi.net 仍然无法自动解析远程引用，而且似乎也无法处理没有“info”和“openapi:3.0.0”部分的文件。

4

1 回答 1

0

事实证明，Redoc 会自动解析远程引用，将 url 中的本地路径替换为远程 url。

所以简单地说：你可以像这样返回一个字符串或文件，一切都应该正常工作。

于 2020-05-17T20:54:12.120 回答