Блог

У меня есть API, задокументированный в swagger, и я хочу иметь какой-то переключатель, чтобы сделать определенную часть описания внутренней.

 parameter:
  - name: abc
    description: |
      line1
      line2
      line3
  

в приведенном выше примере возможно ли ввести какое-либо переключение, чтобы строка 3 не отображалась в итоговом документе. Я использую openapi-filter.js пометить объекты и атрибуты как x-internal, но я понятия не имею, как это сделать, чтобы переключить часть описания.

В OpenAPI нет функции (и, насколько я знаю, не было в Swagger), чтобы скрыть часть описания, как вы описываете. Я рекомендую использовать ваше собственное x-internal-info поле или что-то, что вы можете проанализировать для соответствующей аудитории. Извините, это не тот ответ, на который вы надеялись!