Добавьте `host`,` basePath` и `Programs` в swagger.json, используя Swashbuckle Aspnetcore - PullRequest
Новая
       12

Добавьте `host`,` basePath` и `Programs` в swagger.json, используя Swashbuckle Aspnetcore

0 голосов
/ 15 декабря 2018

Я использую официальный пошаговый метод документации для настройки Swagger UI и создания файла JSON Swagger в моем приложении API ядра ASP.NET.

Начало работы с Swashbuckle и ASP.NET Core

Если я посмотрю на сгенерированный файл swagger.json - в нем отсутствуют три важных свойства host, basePath и schemes

Пожалуйста, помогите мне понять, какой фрагмент кода можетЯ добавляю, что генерируемый swagger.json будет иметь следующие упомянутые свойства / значения.

Вот идеальный swagger.json - обратите внимание на значения host, basePath и schemes, которыеотсутствует, если я следую коду документации в моем приложении 

{
  "swagger": "2.0",
  "info": {
    "version": "v1",
    "title": "Demo API Title"
  },
  "host": "some-url-that-is-hosted-on-azure.azurewebsites.net",
  "basePath": "/api",
  "schemes": ["https"],
  "paths": {
    "/Account/Test": {
      "post": {
        "tags": [
          "Admin"
        ],
        "summary": "Account test method - POST",
        "operationId": "AccountTest",
        "consumes": [],
        "produces": [
          "text/plain",
          "application/json",
          "text/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "type": "boolean"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "NumberSearchResult": {
      "type": "object",
      "properties": {
        "number": {
          "type": "string"
        },
        "location": {
          "type": "string"
        }
      }
    }
  },
  "securityDefinitions": {
    "Bearer": {
      "name": "Authorization",
      "in": "header",
      "type": "apiKey",
      "description": "Authorization. Example: \"Authorization: Bearer {token}\""
    }
  },
  "security": [
    {
      "Bearer": []
    }
  ]
}

1 Ответ

0 голосов
/ 15 декабря 2018

Вы можете реализовать и зарегистрировать свой собственный IDocumentFilter и установить там нужные значения.

public class MyDocumentFilter : IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        swaggerDoc.Host = "some-url-that-is-hosted-on-azure.azurewebsites.net";
        swaggerDoc.BasePath = "/api";
        swaggerDoc.Schemes = new List<string> { "https" };
    }
}

А затем зарегистрируйте его через 

services.AddSwaggerGen(options =>
{
    options.DocumentFilter<MyDocumentFilter>();
});
...