1-) .Net Core Web Api - İsteklere açıklama ekleme Add comments to requests Annotations api request description
1- > yükle Install-Package Swashbuckle.AspNetCore.Annotations
2- FcmSendNetCoreApi.csproj aşağıdakini ekle
<GenerateDocumentationFile>true</GenerateDocumentationFile>
aşağıdaki gibi
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup> <GenerateDocumentationFile>true</GenerateDocumentationFile> </PropertyGroup>
</Project> |
/// Kırpma ve arka plan temizleme işlemleri. /// </summary> /// <param name="kirp">0 ise orijinal boyut, değilse kırpar.</param> /// <param name="removeBack">true ise siyah olmayan pikselleri siler.</param> /// <param name="siyahpixelOrani">0.1f - 0.5f arası bir oran.</param> /// <param name="cozOran"> /// 0 demek Auto, şu değerlerden biri olabilir: /// <list type="bullet"> /// <item> /// <description>Auto,</description> /// </item> /// <item> /// <description>4,</description> /// </item> /// <item> /// <description>2.5,</description> /// </item> /// <item> /// <description>2,</description> /// </item> /// <item> /// <description>1.5,</description> /// </item> /// <item> /// <description>1,</description> /// </item> /// <item> /// <description>0.5,</description> /// </item> /// <item> /// <description>0.25,</description> /// </item> /// </list> /// </param> /// <param name="removeBack">true ise siyah olmayan pikselleri siler.</param> [HttpPost] [Route("ocrBas64")] public ActionResult ocrBase64(OcrReq req) { var txt = imageApi.ocrBase64(req);
return Ok(txt);
|
builder.Services.AddSwaggerGen(c =>
{
c.EnableAnnotations(); // Annotations'ı etkinleştir
});
5- ) EN İYİSİ BU
[SwaggerOperation(Summary = ApiDocs.ConfirmRezSummary, Description = ApiDocs.ConfirmRezDescription)] [HttpPost("ConfirmRez")]
public async Task<IActionResult> ConfirmRez(ConfirmRezRequest request)
public static class ApiDocs { public const string ConfirmRezSummary = "rezervasyon confirm işlemi";
public const string ConfirmRezDescription = @" <details> <summary><b>ÖRNEK REQUEST</b></summary> <pre> { ""authentication"": { ""userID"": ""apsdfsdfim.com"", ""userPSW"": ""Rmossdfsdf2025"", ""propertyID"": ""14sdfsdf9"" }, ""reservations"": { ""reservation"": [ { ""reselivaId"": ""1"", ""pmsId"": ""1"", ""changeToken"": ""1"" } ] } } </pre> </details>
<details> <summary><b>AÇIKLAMA</b></summary> reselivaId = getRezervasyondaki reservno demek<br/> pmsId = getRezervasyondaki reservno demek (bizdeki id olabilir ama aynısını geç)<br/> changeToken = getRezervasyondaki changetoken demek </details> "; } |