In the previous post, I introduced Swagger and showed how to set up your project for Swagger. In this post I will show how to add Swagger comments to annotate your program.
In earlier posts we looked at the database of cars and the Get method that retrieves the entire list. That can be quite a lot of data going over the wire. What we want instead is to send pages. I’ll show that briefly and then we’ll annotate that code.
In the CarController we’ll have a Get method that takes three parameters: showDeleted, pageNumber and pageSize. The first we’ve seen before, it determines whether the list returned to the caller will include our deleted records. The second, pageNumber, will designate which page of data we want to return (zero based). The third parameter, pageSize, will designate how many records to return per page.
Thus, if we were to write
Get(false,3,4)
we would expect to get back records 17, 18, 19 and 20, because page 0 would have records 1-4, page 1 would have 5-8, etc.
Here is the compete endpoint that will directly call our repository (we won’t bother with a service for this example).
public async Task<IEnumerable<Car>> Get([FromRoute] bool showDeleted, int pageNumber, int pageSize )
{
return await _carRepository.Get(showDeleted, pageNumber, pageSize);
}
When the repository is called, the parameters are passed in, and it does its magic. For now, however, we are only concerned with documenting this method. We do that with XML comments, designated by three forward slash marks (///).
First, we will document the purpose of the endpoint; that is, what it does. We do that in the summary
/// <summary>
/// Get all the cars in the Database
/// </summary>
Next, we want to document the parameters
/// <param name="returnDeletedRecords">If true, the method will return all the records,
/// including the ones that have been deleted</param>
/// <param name="pageOffset">which page to display</param>
/// <param name="pageSize">how many records to display per page</param>
Finally, I’m going to document the possible response codes. Note, these are, by no means, all that you can document, but they’ll give us a good idea of how it is done
/// <response code="200">Cars returned</response>
/// <response code="404">Specified Car not found</response>
/// <response code="500">An Internal Server Error prevented the request from being executed.</response>
When an error is encountered and we return one of these codes, the text we’ve specified goes along for the ride, which is enormously helpful to the calling client.
At the top of the swagger page is our summary
At each parameter is our designated text
Finally, each of the error codes is documented
It is a best practice to document all of the endpoints. Many developers go further, and document all of the methods in both the service and the repository; that is a decision to be made by the team. Since the endpoint is the only thing visible to the client, it has the greatest claim on your time and effort. Remember, “comments rust,” and that is as true for Swagger comments as any other.
Народ, привет! долго присматривался к разным платформам, но на прошлой неделе все-таки зарегился ради интереса в mel bet. Скажу так — очень зашло с первых минут,. У кого новый айфон — всё четко и стабильно работает. Надо скачать мелбет на андроид? За пять минут софт поставил на смарт,.
Короче, переходите, точно не пожалеете: . Кстати, кто спрашивал про мелбет приложение — приложение вообще не вылетает,. И фрибеты регулярно прилетают на баланс,. Я лично всё проверил на себе — всё честно и без обмана. Всем искренне рекомендую. Пользуйтесь на здоровье, пусть повезет!
Nicely put. Many thanks!
Ребята, всем привет! долго сомневался до последнего, но на прошлой неделе таки попробовал сделать пару ставок в мелбет. Честно? Зашло прям на ура,. Особенно если вам надо скачать melbet на андроид — у меня смартфон далеко не новый,, но никаких тормозов вообще нет.
В общем, гляньте сами все условия по ссылке: мелбет скачать казино https://v-bux.ru. Кстати, кто спрашивал про мелбет приложение — там есть удобный отдельный раздел,. И бонусы на первый депозит отличные дают,. Я лично всё проверял на себе — служба поддержки вообще не тупит. Сам теперь только туда. Дерзайте, пусть повезет!
You actually revealed this exceptionally well.
Honestly, I’ve wasted so much time on sketchy rental deals around South Beach. You book a premium ride online, show up, and they hand you keys to something with a dented bumper. No thanks, I am completely done with that circus. When you are trying to find a reliable premium fleet down here, seriously, do your homework first and don’t just trust social media ads. Miami without a decent whip is pretty rough, especially if you want ice-cold AC and no ridiculous daily mileage caps.
I’ve literally compared maybe 15 different local providers last month alone, until I finally stumbled across one that actually delivers what it promises. If you are looking for an honest source for premium rentals across Florida, check the details here: luxury car rental service luxury car rental service. Oh, and definitely bring polarized sunglasses, because that Florida sun is absolutely no joke. Just drive safe out there and don’t let them upsell you on unnecessary insurance nonsense. hope this helps someone save a few bucks.
Социальная поддержка пожилых, включая общение, досуг и сопровождение – Узнайте больше информации <a href=
https://wakelet.com/@Rodnoyochag73334
Amazing all kinds of wonderful material.
Kudos. Wonderful information.
Слушайте, а вы в курсе, что найти нормальную клинику сейчас — это всегда целая проблема и головная боль. Многие лично сталкивались с такой ситуацией,, когда кому-то из членов семьи срочно понадобилась грамотная помощь врачей. И тут сразу возникает главный вопрос: куда именно везти человека?
Я сам недавно детально изучал этот вопрос, искал по-настоящему работающий и безопасный выход. В интернете сейчас столько мусора и дорвеев, что голова идет кругом. Короче говоря, советую присмотреться к одному источнику, там действительно раскладывают по полочкам всю подноготную про круглосуточную наркологическую поддержку и условия проживания. В такой ситуации лучше один раз внимательно глянуть самостоятельно, чтобы четко во всем разобраться.
Вся актуальная информация и контакты доступны прямо здесь: наркологические стационары http://www.narkologicheskij-staczionar-sankt-peterburg-12.ru. Честно говоря, после изучения всех условий, насколько там много подводных камней, на которые стоит обращать внимание, включая комфортные условия содержания, современные палаты и полную анонимность. Для Санкт-Петербурга это точно один из самых лучших вариантов, который стабильно работает и имеет хорошие отзывы.
Honestly, I’ve wasted so much time on sketchy rental deals around South Beach. Or worse — they freeze your credit card for an extra two grand and smile like it’s totally normal. No thanks, I am completely done with that circus. If you actually need a proper vehicle to cruise around the city, make sure to check the actual fleet reviews before signing anything. Everyone who lives here knows that having a solid car is essential, whether you are heading to Brickell, Coconut Grove, or just driving down to Key Biscayne.
Most of these local agencies are just fancy websites hiding a garbage fleet, but I eventually found a service with zero hidden fees and no bait-and-switch tactics. If you are looking for an honest source for premium rentals across Florida, check the details here: luxury car rental south beach luxury car rental south beach. Oh, and definitely bring polarized sunglasses, because that Florida sun is absolutely no joke. Just drive safe out there and don’t let them upsell you on unnecessary insurance nonsense. let me know if you guys know any other clean spots.
Wonderful advice, Kudos!
Bir arkadaş tavsiyesiyle başladım. Ne yalan söyleyeyim ilk başta şüpheyle yaklaştım. Ama sonunda doğru adresi buldum işte.
Bilenler zaten anlar. Sistem ayarlarını doğru yaptıktan sonra süreç çok basit. Giriş adresi tam olarak şurada: 1xbet türkiye 1xbet türkiye. Kısaca özet geçeyim — 1xbet spor bahislerinin adresi burası.
Arayüzü anlaşılır, takılmazsınız. Kendi adıma konuşmam gerekirse — her şey düşünülmüş. Şimdiden keyifli oyunlar…
Nicely put, Regards!
Thanks. Numerous information.
Many thanks! Ample information!
Açıkçası bu işe yeni başlayanlar için ideal. Kapanan sitelerden çektim resmen anlatamam. Gerekli teknik incelemeleri tek tek tamamlayıp sistemi test ettim. Güvenilir bir kaynak bulmanın ne kadar zor olduğunu hepimiz biliyoruz işte size o adres: 1xbet güncel adres 1xbet güncel adres. Şimdi size doğru düzgün anlatayım — spor bahislerine meraklıysanız burası tam size göre.
bonusları bile fena değil действительно. İşin aslını söylemek gerekirse — en güvendiğim liman burası oldu artık. Herkese hayırlı olsun…
Amazing quite a lot of great knowledge!
Açıkçası ben de merak ediyordum. Birçok site denedim ama. En sonunda her derde deva bir kaynak keşfettim.
Casino sevenler bilir. Uyarıları dikkate alarak sistemi kurun. Giriş adresi aynen şu şekilde: 1xbet güncel giriş 1xbet güncel giriş. Velhasıl kelam — 1xbet türkiye için tek doğru adres bu.
Bonusları gayet iyi. Dost meclisinde öğrendim — deneyen memnun kalmış. Selametle…
Image to Image AI is a powerful online tool that transforms any picture into a new, enhanced, or stylized version using cutting-edge AI technology.
Ребят, наконец-то наткнулся на реальный опыт. Там всё разложено по полочкам, без лишней воды и тупых SEO-текстов. Рекомендую заглянуть, чтобы не совершать глупых ошибок, как я в прошлый раз. Вот скачать мелбет на андроид скачать мелбет на андроид — переходите, там вся суть. Если останутся вопросы, пишите прямо там в комментариях, админ отвечает быстро.
Случайно наткнулся на один гайд, Прям беда реальная: нужно срочно проверить один подозрительный номер. Полез в глубокий поиск по веткам. И знаете что? Тут главное знать, куда именно смотреть и какие базы юзать.
Короче, если вас сейчас волнует тот же самый вопрос — как вычислить анонимного абонента, то есть один проверенный временем вариант. Конкретно про то, где найти по телефонному номеру актуальные данные — вот здесь всё максимально норм расписано: отследить человека по номеру телефона отследить человека по номеру телефона.
Друзьям ссылку скинул в телегу, им тоже помогло. Потому что а тут выложена конкретная и структурированная информация. В общем, не теряйте свое время зря на разводняк. Век живи — век учись, как говорится.
Uzun süredir oynuyorum diyebilirim. Her gün yeni bir engelleme haberi alınca insan bıkıyor. Ama sonunda her derde deva bir adrese ulaştım.
Casino oyunlarına meraklıysanız burayı kesinlikle tavsiye ederim. Güncel sistem ayarlarını kontrol ettikten sonra erişim sağlamak en mantıklısı. Giriş adresi tam olarak şu şekilde: 1xbet türkiye [url=https://1xbet-giris-82.com]1xbet türkiye[/url]. Ne diyeyim yani — 1xbet spor bahislerinin adresi değişti.
Müşteri hizmetleri bile ilgili. Daha önce birçok site denedim — en memnun kaldığım yer burası oldu. Şimdiden bol kazançlar…
Народ, привет! Ох, уже голова болит с этим тимбилдингом, нужны нормальные презенты для партнеров. Может, кто шарит где лучше брать сувенирную продукцию с логотипом. изготовление корпоративных подарков изготовление корпоративных подарков Говорят, сейчас модно заказывать корпоративные подарки сувениры из экокожи — но кто делает качественно. Просили ещё брендированные кружки и толстовки. Заранее респект тем, кто откликнется с контактами проверенными.
I really appreciate the balanced approach you took while putting this piece together, highlighting the most important aspects clearly while keeping the overall narrative enjoyable and highly informative throughout.
http://www.rcmecano.fr/2026/06/09/%e4%b8%96%e7%95%8c%e6%9d%af%e4%b8%8b%e6%b3%a8%e7%bd%91%e7%ab%99%e6%8e%a8%e8%8d%90%e6%a6%9c%e5%8d%95%e5%8f%8a%e5%b9%b3%e5%8f%b0%e7%89%b9%e8%89%b2%e5%88%86%e6%9e%90/
Дизайн интерьера квартиры с продуманной эргономикой и современными решениями, узнайте подробности здесь <a href=
https://www.jumper.ru/search.html?search=%D3%F1%EB%F3%E3%E8+%EF%EE+%F0%E5%EC%EE%ED%F2%F3+%EA%E2%E0%F0%F2%E8%F0%FB+%E8+%E4%E8%E7%E0%E9%ED%F3+%E8%ED%F2%E5%F0%FC%E5%F0%E0
HEIC to JPG is the perfect solution for users who need to convert their iPhone photos to the more widely supported JPG format.
References:
Usa online casinos https://dailybeacon.site/item/casino-20-euro-bonus-ohne-einzahlung-2026-der-kalte-blick-hinter-dem-werbetrugbild
I love assisting companies expand with electronic advertising.
For moore keywords to search for targets see http://nanacast.com/100kshoutout
Great breakdown of using Swagger comments to generate clean API documentation. I’ve found that adding XML comments in .NET really helps keep the team aligned, especially when onboarding new developers. Do you have any tips for handling complex response types or nested objects in Swagger?
Народ, привет! Ох, уже голова болит с этим тимбилдингом, нужны нормальные презенты для партнеров. Может, кто шарит где лучше брать сувенирную продукцию с логотипом. брендированная продукция брендированная продукция Говорят, сейчас модно заказывать корпоративные подарки сувениры из экокожи — но кто делает качественно. Просили ещё брендированные кружки и толстовки. Заранее респект тем, кто откликнется с контактами проверенными.
The overall tone of this post feels calm and insightful at the same time, which helps create a comfortable and enjoyable reading experience for different audiences.
Где купить шубу в Турции
Производитель смол для творчества: молды, красители, аксессуары — здесь <a href=
https://jobs.theeducatorsroom.com/author/polina1191/
Restore Old Photos helps families, historians, and photographers preserve memories by bringing old pictures back to life.
square face generator lets you create cute pixel art avatars for free — no login required, instant 256×256 PNG download for Discord, Twitter, and TikTok
Brat Generator – Free Online Brat Style Cover Text Generator.
Правило ответственной игры состоит в контролируемом отношении к игровым платформам.
Этот принцип включает личностное ограничение длительности и расходов на сессию.
Участнику рекомендуется заранее определить потолок потерь и строго соблюдать этот предел.
Важно рассматривать игру исключительно как способ досуга, а не средство заработка.
При возникновении признаков проблемного поведения (погоня за потерянным) нужно использовать тайм-аут или блокировку аккаунта.
Соблюдение данных установок гарантирует ментальное благополучие и финансовую стабильность пользователя.
https://e-transavto.ru/read/snizhenie-covid-19-v-voronezhskoy-oblasti-tsifry-tendentsii-vyvody-285/
Правило ответственной игры состоит в осознанном отношении к игровым платформам.
Этот принцип включает добровольное ограничение длительности и расходов на сессию.
Участнику рекомендуется заранее выставить потолок потерь и строго соблюдать этот предел.
Крайне необходимо воспринимать игру только как вид досуга, а не источник заработка.
В случае появлении симптомов проблемного поведения (погоня за проигрышем) стоит использовать паузу или блокировку аккаунта.
Следование этих правил гарантирует психологическое благополучие и финансовую стабильность игрока.
https://relax-spb.ru/read-info/1205-tyomnye-teni-podlinnosti-kak-vdova-ernsta-neizvestnogo-predvidela-falsifikatsiyu-na-vystavke.html
HEIC to JPG is a free online tool that allows anyone to quickly and easily convert HEIC images to JPG format.
I appreciate how the tone here stays easygoing and informative, helping the discussion feel more natural and comfortable overall.
Сад и огород
References:
Jeu de roulette https://briefjournal.site/item/jetzt-legal-spielen-mit-deutscher-casino-lizenz
tải go88 là nền tảng giải trí trực tuyến phát triển từ năm 2017, sở hữu hệ thống hiện đại, tốc độ xử lý nhanh, kho nội dung đa dạng.
Лекарство Оземпик считается передовым лекарством для лечения сахарного диабета второго типа.
Данный агент применяется подкожно раз в неделю посредством эргономичной шприц-ручки.
Центральное действие Оземпика — стимулировать рецепторы, вызывая снижение глюкозы в плазме.
дешевый аналог оземпика
Помимо регуляции сахара, препарат помогает умеренному избавлению от лишних килограммов.
Курс Оземпика обязан прописываться исключительно врачом с учётом противопоказаний.
Во время использовании возможны нежелательные эффекты, например расстройство желудка или нарушение стула, которые часто исчезают со временем.
Принцип здорового гемблинга заключается в осознанном подходе к азартным развлечениям.
Этот принцип подразумевает добровольное ограничение длительности и расходов на игру.
Игроку следует предварительно выставить максимальную сумму и строго соблюдать этот лимит.
Важно воспринимать игру только как вид досуга, а не средство дохода.
В случае появлении симптомов проблемного поведения (погоня за потерянным) нужно использовать тайм-аут или самоисключение.
Следование этих установок гарантирует ментальное здоровье и денежную стабильность игрока.
https://tltrock.ru/material/2026-06-01-tragediya-na-tulskom-dvore-malysh-sbit-bmw-x5.html
tải go88 là nền tảng giải trí trực tuyến phát triển từ năm 2017, sở hữu hệ thống hiện đại, tốc độ xử lý nhanh, kho nội dung đa dạng.
tải go88 là nền tảng giải trí trực tuyến phát triển từ năm 2017, sở hữu hệ thống hiện đại, tốc độ xử lý nhanh, kho nội dung đa dạng.
Website: https://taigo88.de/
Website: https://taigo88.de/
Swagger comments are a fantastic way to document .NET APIs without cluttering your code. Using XML comments combined with Swashbuckle makes it so much easier for other developers to understand endpoints at a glance. This is a great guide for anyone getting started with API documentation in C#.
That is a very good tip especially to those new to the
blogosphere. Short but very precise info… Many thanks for
sharing this one. A must read article!
Feel free to visit my web-site; 원장 이승욱
College Station corporate shuttle services help businesses manage employee transportation, airport pickups, and executive travel needs. We offer luxury transportation, reliable corporate transfers, and professional chauffeurs dedicated to efficient and comfortable business transportation services.