Я хочу создать макет сервера для разработчиков интерфейса нашей команды.
Вот мой пример файла api-y.yaml:
openapi: 3.0.0
info:
title: Mock API
description: A simple mock API
version: 1.0.0
paths:
/api/hello:
get:
summary: Returns a hello message
responses:
'200':
description: A hello message
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Hello, world!
program.cs:
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers();
builder.Services.AddSwaggerGen();
var app = builder.Build();
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
app.UseSwaggerUI();
}
app.UseAuthorization();
app.MapControllers();
app.Run();
Что еще мне нужно сделать, чтобы увидеть конечную точку /api/hello в Swagger при запуске проекта?
Я пробовал пример кода, который я нашел в Интернете и получил от ChatGPT, но мне это не удалось
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers();
builder.Services.AddSwaggerGen(options =>
{
options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "api-j.yaml"));
});
var app = builder.Build();
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
app.UseSwaggerUI();
}
app.UseAuthorization();
app.MapControllers();
app.Run();
Я также пробовал использовать файл JSON:
{
"openapi": "3.0.0",
"info": {
"title": "Mock API",
"description": "A simple mock API",
"version": "1.0.0"
},
"paths": {
"/api/hello": {
"get": {
"summary": "Returns a hello message",
"responses": {
"200": {
"description": "A hello message",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Hello, world!"
}
}
}
}
}
}
}
}
}
}
}
Подробнее здесь: https://stackoverflow.com/questions/788 ... r-open-api
