ШАГ 1 - ДОБАВЛЕНИЕ SWAGGER (ОТКРЫТЫЙ ИНТЕРФЕЙС API) Первым шагом является добавление Swagger, который является открытым интерфейсом API и может быть импортирован в управление API.Чтобы сначала добавить swagger, мы должны установить пакет N uGet в наши существующие приложения.
ШАГ 2 - РЕДАКТИРОВАНИЕ ЗАПУСКА КЛАССА ДЛЯ РАЗМЕЩЕНИЯ SWAGGER В НАШЕМ ПРИЛОЖЕНИИ Перейдите к Startup.cs или вашему классу Startup, если вы настроили его под другим именем и измените ConfigureServices и Configure методыдобавить Swagger в ваше приложение WebAPI, как описано ниже двумя способами.
Настройка служб:
public void ConfigureServices (IServiceCollection services)
{
services.AddMvc (). SetCompatibilityVersion (CompatibilityVersion.Version_2_1);
// Register the Swagger generator, defining 1 or more Swagger documents
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
});
// Register the Swagger generator, defining 1 or more Swagger documents
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("MyApi", new Info
{
Version = "v1",
Title = "My API",
Description = "A simple example ASP.NET Core Web API",
TermsOfService = "None",
Contact = new Contact
{
Name = "mfouad",
Email = string.Empty,
Url = ""
},
License = new License
{
Name = "Use under LICX",
Url = "https://example.com/license"
}
});
});
}
и настройка:
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseHsts();
}
// Enable middleware to serve generated Swagger as a JSON endpoint.
app.UseSwagger();
// Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
// specifying the Swagger JSON endpoint.
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
app.UseHttpsRedirection();
app.UseMvc();
}
ШАГ 3 - ОПУБЛИКОВАТЬ ЭТИ ИЗМЕНЕНИЯ В СЛУЖБЕ ПРИЛОЖЕНИЯ AZURE
Щелкните правой кнопкой мыши проект и выберите «Опубликовать», чтобы добавить новые изменения в службу приложений.
Выберите и создайте или создайте новую службу приложений, если не существует службы приложений, существующей
Опубликуйте это в службе приложений.
После публикации убедитесь, что http://{ YourAppServiceName} .azurewebsites.net / swagger загружает страницу интерфейса API
Перейдите к https://{YourAppServiceName}.azurewebsites.net/swagger/v1/swagger.json
ШАГ 4 - ДОБАВИТЬ APIS К УПРАВЛЕНИЮ API
- Перейдите к ресурсу управления API в Azure
- Выбратьиз левой панели API-интерфейсов
- Нажмите OpenAPI
- Вам будет предоставлена форма для заполнения, вы можете либо загрузить файл json на свой локальный компьютер и проверить его, используя инструмент редактора swagger, еслиесть проблемы с импортом этого файла, который может дать вам рекомендации по исправлению элементов перед его загрузкой.
- Добавьте конечную точку Swagger.json или файл в следующей форме и нажмите кнопку «Создать».
- Добавьте свою конечную точку API в управление API, щелкните настройки на ленте и добавьте URL-адрес службы приложения в поле URL-адреса веб-службы, как показано на рисунке ниже.
- Проверьте свои API в управлении API с помощьющелкнув «Тест» на ленте, выберите один из API-интерфейсов, чтобы отправить пример запроса в соответствии с изображением ниже.