Nano Hash - криптовалюты, майнинг, программирование

OpenAPI - разные схемы для каждой операции на одном и том же ресурсе

Я использую OpenAPI 3.0 для описания API, в котором каждый ресурс имеет слегка отличающуюся схему в зависимости от его работы. По сути, некоторые свойства доступны для редактирования и / или требуются в зависимости от того, является ли это запрос POST или PUT.

Есть ли лучший способ сделать это, кроме указания схемы для каждой такой операции? (где field2 читается только в PUT)

В идеале я хотел бы указать схему (то есть все свойства) в одном месте, а затем переопределить некоторые свойства (например, readOnly) для каждой операции.

{
   "paths":{
      "/users":{
         "put":{
            "responses":{
               "200":{
                  "$ref":"#/components/schemas/users_put"
               }
            }
         },
         "post":{
            "responses":{
               "200":{
                  "$ref":"#/components/schemas/users_post"
               }
            }
         }
      }
   },
   "components":{
      "schemas":{
         "users_post":{
            "properties":{
               "field1":{
                  "readOnly":true,
                  "type":"integer"
               },
               "field2":{
                  "type":"string"
               }
            }
         },
         "users_put":{
            "properties":{
               "field1":{
                  "readOnly":true,
                  "type":"integer"
               },
               "field2":{
                  "type":"string",
                  "readOnly":true
               }
            }
         }
      }
   }
}
openapi
09.09.2020

Ответы:


1

Насколько мне известно, в моделях openapi / swagger нет механизма переопределения. Но композиция (расширение) моделей доступна.

Поскольку в вашем примере вам нужно обновить только директивы readOnly (что означает, что вы помечаете свойства, доступные только в ответах), попробуйте другой подход, когда вы описываете запросы и ответы отдельно.

В вашем примере ответ для методов put и post будет одинаковым (потому что они оба имеют field1 и field2), и только put будет иметь запрос (потому что в post все поля только для чтения):

(Я использую yaml для краткости, но его легко преобразовать в json обратно)

paths:
  "/users":
    put:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/users_put_request'
      responses:
        '200':
          "$ref": "#/components/schemas/users_response"
    post:
      responses:
        '200':
          "$ref": "#/components/schemas/users_response"
components:
  schemas:
    users_response:
      field1:
        type: integer
      field2:
        type: integer

    users_put_request:
      field2:
          type: string

Вероятно, при таком подходе подробно описываются разные части моделей.

10.09.2020
Новые материалы
Кластеризация: более глубокий взгляд
Кластеризация — это метод обучения без учителя, в котором мы пытаемся найти группы в наборе данных на основе некоторых известных или неизвестных свойств, которые могут существовать. Независимо от..
Как написать эффективное резюме
Предложения по дизайну и макету, чтобы представить себя профессионально Вам не позвонили на собеседование после того, как вы несколько раз подали заявку на работу своей мечты? У вас может..
Частный метод Python: улучшение инкапсуляции и безопасности
Введение Python — универсальный и мощный язык программирования, известный своей простотой и удобством использования. Одной из ключевых особенностей, отличающих Python от других языков, является..
Как я автоматизирую тестирование с помощью Jest
Шутка для победы, когда дело касается автоматизации тестирования Одной очень важной частью разработки программного обеспечения является автоматизация тестирования, поскольку она создает..
Работа с векторными символическими архитектурами, часть 4 (искусственный интеллект)
Hyperseed: неконтролируемое обучение с векторными символическими архитектурами (arXiv) Автор: Евгений Осипов , Сачин Кахавала , Диланта Хапутантри , Тимал Кемпития , Дасвин Де Сильва ,..
Понимание расстояния Вассерштейна: мощная метрика в машинном обучении
В обширной области машинного обучения часто возникает необходимость сравнивать и измерять различия между распределениями вероятностей. Традиционные метрики расстояния, такие как евклидово..
Обеспечение масштабируемости LLM: облачный анализ с помощью AWS Fargate и Copilot
В динамичной области искусственного интеллекта все большее распространение получают модели больших языков (LLM). Они жизненно важны для различных приложений, таких как интеллектуальные..