Sobes.tech
Junior — Middle

Kas teil on kogemusi Swagger tööriista kasutamisel API-de dokumenteerimiseks ja testimiseks?

sobes.tech AI

Vastus AI-lt

Jah, Swagger on populaarne tööriist REST API-de dokumenteerimiseks ja testimiseks. See võimaldab automaatselt genereerida interaktiivset dokumentatsiooni, mis põhineb koodi kommentaaridel või OpenAPI spetsifikatsioonidel. C#-s kasutatakse sageli Swashbuckle teeki, mis integreerub ASP.NET Core'iga ja genereerib Swagger UI.

Näide Swaggeri integreerimisest ASP.NET Core'is:

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddSwaggerGen();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "Minu API V1");
    });

    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

See võimaldab arendajatel ja testijatel kiiresti näha API kirjelduse ning teha otse brauserist päringuid.