Документировать возможные значения для строки, используя Swagger / C #?

Question

Есть ли способ, которым я могу в сводном XML-методе перечислить возможные значения строкового параметра и задокументировать его в Swagger?

Как и в методе ниже, возможные значения для myParam являются Y и N , я хочу получить его в документации по Swagger.

/// <summary>
/// My method.
/// </summary>
/// <param name="myParam">String parameter with predefined values.</param>
/// <returns>Something.</returns>
[HttpGet]
[ProducesResponseType(typeof(string), 200)]
public JsonResult MyMethod(string myParam)
{
   ...
}

Answer 1

Есть ли способ, которым я могу в сводном XML-методе перечислить возможные значения строкового параметра и задокументировать его в Swagger?

Нет, вы не можете этого сделать

Однако, swagger определяет поле description , которое поддерживает rich format , и которое вы можете использовать для описания ваших параметров и, следовательно, допустимых значений, которые могут быть переданы. Это будетбыть видимым любому, кто использует определение API.

Что-то вроде:

paths:
  /MyMethod/myParam:
    get:
      summary: Gets a user by ID.
      parameters:
        - in: path
          name: myParam
          type: string
          required: true
          description: Must be in the form of "X" or "Y"