loopback4 - неправильное отображение отношений в спецификации openapi - PullRequest
Новая
       34

loopback4 - неправильное отображение отношений в спецификации openapi

0 голосов
/ 05 апреля 2020

я борюсь с отображением в openapi spe c отношений в обратной петле 4.

Есть две сущности: Plan и PlanItem, связанные с "Plan hasMany PlanItems" В моей конечной точке spe c i Мы объявили о включении отношения следующим образом: 

  @authenticate('jwt')
  @get('/{id}', {
    responses: {
      '200': {
        description: 'Plan for given id, including items',
        content: {
          'application/json': {
            schema: getModelSchemaRef(Plan, {
              title: "PlanWithRelations",
              exclude: ['ownerId'],
              includeRelations: true
            })
          },
        },
      },
    },
  })
  async findOne(
    @param.path.string('id') id: string,
  ): Promise<Plan | null> {
    return this.plansService.findOne(id);
  }

результирующий раздел компонентов в openapi. json выглядит так: 

{
  "openapi": "3.0.0",
  "info": {
    "title": "ngbm-api - NGBM API v1.0",
    "version": "1.0.0",
    "contact": {

    }
  },
  // ...
  "components": {
    "schemas": {
      // ...
      "PlanWithRelations": {
        "title": "PlanWithRelations",
        "description": "(Schema options: { title: 'PlanWithRelations', exclude: [ 'ownerId' ], includeRelations: true })",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PlanWithRelations"
            }
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      },
    }
  }
}

, как вы можете видеть элементы массив в PlanWithRelations имеет $ ref для той же схемы PlanWithRelations, а не для PlanItem

Может кто-нибудь подсказать, как это исправить? Если вам нужна дополнительная информация, не стесняйтесь дать мне подсказку.

вот мой loopback --version вывод: 

@loopback/cli version: 2.2.1

@loopback/* dependencies:
  - @loopback/authentication: ^4.1.1
  - @loopback/boot: ^2.0.2
  - @loopback/build: ^5.0.0
  - @loopback/context: ^3.2.0
  - @loopback/core: ^2.2.0
  - @loopback/metadata: ^2.0.2
  - @loopback/openapi-spec-builder: ^2.0.2
  - @loopback/openapi-v3: ^3.1.1
  - @loopback/repository-json-schema: ^2.0.2
  - @loopback/repository: ^2.0.2
  - @loopback/rest: ^3.1.0
  - @loopback/testlab: ^2.0.2
  - @loopback/docs: ^3.2.1
  - @loopback/example-hello-world: ^2.0.2
  - @loopback/example-log-extension: ^2.0.2
  - @loopback/example-rpc-server: ^2.0.2
  - @loopback/example-todo: ^3.0.2
  - @loopback/example-soap-calculator: ^2.0.2
  - @loopback/service-proxy: ^2.0.2
  - @loopback/http-caching-proxy: ^2.0.2
  - @loopback/http-server: ^2.0.2
  - @loopback/example-todo-list: ^3.0.2
  - @loopback/dist-util: ^0.4.0
  - @loopback/rest-explorer: ^2.0.2
  - @loopback/eslint-config: ^6.0.2
  - @loopback/example-express-composition: ^2.0.2
  - @loopback/example-greeter-extension: ^2.0.2
  - @loopback/booter-lb3app: ^2.0.2
  - @loopback/example-lb3-application: ^2.0.2
  - @loopback/example-greeting-app: ^2.0.2
  - @loopback/example-context: ^2.0.2
  - @loopback/repository-tests: ^0.11.2
  - @loopback/extension-health: ^0.3.2
  - @loopback/authorization: ^0.5.2
  - @loopback/rest-crud: ^0.7.2
  - @loopback/security: ^0.2.2
  - @loopback/authentication-passport: ^2.0.2
  - @loopback/example-metrics-prometheus: ^0.2.2
  - @loopback/extension-metrics: ^0.2.2
  - @loopback/model-api-builder: ^2.0.2
  - @loopback/extension-logging: ^0.2.2
  - @loopback/example-access-control-migration: ^1.1.2
  - @loopback/example-file-transfer: ^1.1.2
  - @loopback/example-rest-crud: ^1.1.1
  - @loopback/apiconnect: ^0.1.1
  - @loopback/example-validation-app: ^1.1.1
  - @loopback/cron: ^0.1.0

1 Ответ

0 голосов
/ 16 апреля 2020

Это известная ошибка, которая при включении «заголовка» приведет к созданию недопустимой схемы.

Обходной путь - удалить ключ «заголовка» из getModelSchemaRef: 

schema: getModelSchemaRef(Plan, {
  exclude: ['ownerId'],
  includeRelations: true
})

PR с исправлением было объединено, и исправление будет выпущено в ближайшее время.

...