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.
anaboliese steroide
References:
https://fkwiki.win/wiki/Post:How_to_Get_a_TRT_Prescription_Buy_Testosterone_Online
best online steroid pharmacy reviews
References:
https://pattern-wiki.win/wiki/Advanced_TRT_Online
testx core and no max shred
References:
http://jobs.emiogp.com/author/finegalley41/
best steroid for weight gain
References:
https://newssignet.space/item/120206
Check this: VRFMDW3ZX – https://dpaste.com/AKWMPCPFW
Үou ought tο Ƅe a рart of a ontest for one
օf thе best sites on thee internet. Ӏ’m going tto recommend
ths site!
Feel free t᧐ suyrf tо mｙ web page: http://www.letmejerk.com
what is the purpose of steroids
References:
http://cqr3d.ru/user/errorbike9/
https://civicmeds.shop/# my canadian pharmacy
canadapharmacyonline
muscle steroids pills
References:
https://md.un-hack-bar.de/s/OzkJMw2Q8R
sublingual steroids
References:
https://pin-it.top/item/591852
animal test stack
References:
https://actualites.cava.tn/user/crayonmeal3/
real anabolic steroids for sale
References:
https://enregistre-le.site/item/604343
illegal anabolic steroids for sale
References:
https://codimd.communecter.org/O3wZn4huRqGQdnKnJGiVAg/
where can i get anabolic steroids
References:
https://pad.stuve.de/s/nJJkQZ8qe
anabolic steroids for muscle growth
References:
https://algowiki.win/wiki/Post:Testosterone_Cypionate_Injection
female bodybuilding steroids side effects
References:
http://okprint.kz/user/tilepantry3/
здесь кракен площадка ссылка
посетить веб-сайт кракен ссылка кракен
corticosteroids side effects long term
References:
https://mcneill-mccall-2.technetbloggers.de/7-best-sites-to-buy-testosterone-online-in-2026
คอนเทนต์นี้ อ่านแล้วเข้าใจง่าย ครับ
ดิฉัน ไปเจอรายละเอียดของ ข้อมูลเพิ่มเติม
ดูต่อได้ที่ Aliza
ลองแวะไปดู
มีการยกตัวอย่างที่เข้าใจง่าย
ขอบคุณที่แชร์ เนื้อหาดีๆ
นี้
และหวังว่าจะมีข้อมูลใหม่ๆ มาแบ่งปันอีก
The atmosphere of this terpene blend – forbidden fruit strain is exceedingly good and true to life, not too strong but hush noticeable in the best way. It blends smoothly and adds a much bettor flavor chart without oppressive the entirety else. Even a close amount makes a argument, which says a lot fro the quality. The packaging was solid, shipping was rakish, and the unimpaired circumstance felt reliable. Really sound product and joined I’d providentially order again.
Коротко поделюсь опытом про казино Dragon Money — играю там уже пару месяцев.
Сезонные миссии с призовым фондом — участвовал, выиграл немного, но сам процесс затягивает. Это не просто «красивая» фича — реально структурирует игровой процесс и даёт дополнительный смысл каждой сессии.
По промокоду SPRING2026 дали 230 фриспинов без депозита. Это напрямую влияет на то, сможешь ли вывести выигрыш потом.
Live-раздел с живыми крупье работает стабильно.
KYC прошёл заранее, поэтому без задержек: залил документы, одобрили за день, дальше всё гладко.
Тот же аккаунт, тот же баланс — никакой разницы. Приложение есть, скачал с сайта. Рекомендую попробовать.
Кину свои пять копеек — с Monro Casino уже несколько месяцев. Думал попробую разок — в итоге остался. казино Monro — для тех кто ценит предсказуемость — то что надо.
Зарегался быстро — email, пароль, страна. Ещё 300 FS дали на первый депозит от 1000 рублей — это уже на старте серьёзная прибавка к балансу.
Каталог у Монро большой — больше девяти тысяч игр. Демо без регистрации работает на большинстве слотов — удобно перед тем как вносить деньги.
Дальше всё проходит без проблем, обычно в течение суток. Минималка на вывод 500 рублей — нормально.
Зеркало только из официальных источников брать, не из поиска — фишинга полно.
Удобно: push-уведомления на статус вывода — не надо постоянно заходить проверять. Чем выше уровень в VIP Club — тем интереснее персональные предложения. А вы в Монро играете или в чём-то другом?
โพสต์นี้ น่าสนใจดี
ค่ะ
ผม ไปเจอรายละเอียดของ หัวข้อที่คล้ายกัน
ที่คุณสามารถดูได้ที่ betflik kiss
น่าจะถูกใจใครหลายคน
เพราะให้ข้อมูลเชิงลึก
ขอบคุณที่แชร์ บทความคุณภาพ นี้
และหวังว่าจะมีข้อมูลใหม่ๆ มาแบ่งปันอีก
Hello guys
Good evening. A 39 very cool site 1 that I found on the Internet.
Check out this site. There’s a great article there. https://lookwhatmomfound.com/2025/03/the-secret-benefits-of-messy-play-why-you-should-let-your-kids-get-dirty.html|
There is sure to be a lot of useful and interesting information for you here.
You’ll find everything you need and more. Feel free to follow the link below.
investigate this site https://mixmy.money/
official statement https://daobase.online/
see here https://yomix.biz/
site web https://swaplab.io
litecoin al – ethereum satın al, felink
Interesting point, appreciate the details. https://blog-preview.io/quick-note-828
check my site Vauld review
stellar tl – xlm try, stellar tl
basics Vauld India
felink – stellar tl, cro usdt
Your Domain Name Vauld news
visit here Vauld withdrawal
litecoin al – felink, clz coin
Many thanks, Numerous information.
https://thaislothub.almoheet-travel.com/sl-xt-khay-hiyth-taek-bxy-ray-chx-kem-na-len
Kudos! I appreciate it. https://escatter11.fullerton.edu/nfs/show_user.php?userid=9633458
He provides a wealth of data on delegation frameworks, group
efficiency, and sustainable business scaling.
โพสต์นี้ น่าสนใจดี ค่ะ
ดิฉัน เพิ่งเจอข้อมูลเกี่ยวกับ เรื่องที่เกี่ยวข้อง
ซึ่งอยู่ที่ betflik
ลองแวะไปดู
เพราะให้ข้อมูลเชิงลึก
ขอบคุณที่แชร์ บทความคุณภาพ
นี้
และหวังว่าจะได้เห็นโพสต์แนวนี้อีก
Terrific posts, Cheers! https://gamedailyth.iamarrows.com/slxt-pg-khxd-khx-sey-ceaa-lk-khay-pg
Hello men
Hello. A 39 fine site 1 that I found on the Internet.
Check out this website. There’s a great article there. https://www.kozanilife.gr/2024/06/22/kalokairines-theatrikes-parastaseis-stin-kozani/|
There is sure to be a lot of useful and interesting information for you here.
You’ll find everything you need and more. Feel free to follow the link below.
посмотреть в этом разделе https://vodkabet-vbt.com
Узнать больше https://drink.vodkabet-zercalo.com/
Hello men
Hello. A 39 fine website 1 that I found on the Internet.
Check out this website. There’s a great article there. https://www.eas.pt/a-receptividade-dos-jogos-de-casino-online-em-eventos-de-casino-reais-na-europa/|
There is sure to be a lot of useful and interesting information for you here.
You’ll find everything you need and more. Feel free to follow the link below.
โพสต์นี้ อ่านแล้วเข้าใจง่าย ครับ
ผม ไปอ่านเพิ่มเติมเกี่ยวกับ
ข้อมูลเพิ่มเติม
ที่คุณสามารถดูได้ที่ Archer
สำหรับใครกำลังหาเนื้อหาแบบนี้
มีตัวอย่างประกอบชัดเจน
ขอบคุณที่แชร์ เนื้อหาดีๆ นี้
และหวังว่าจะได้เห็นโพสต์แนวนี้อีก
คอนเทนต์นี้ อ่านแล้วเข้าใจง่าย ครับ
ผม ไปเจอรายละเอียดของ เนื้อหาในแนวเดียวกัน
ดูต่อได้ที่ flik 93
เผื่อใครสนใจ
มีการยกตัวอย่างที่เข้าใจง่าย
ขอบคุณที่แชร์ เนื้อหาดีๆ นี้
และหวังว่าจะได้เห็นโพสต์แนวนี้อีก
โพสต์นี้ อ่านแล้วได้ความรู้เพิ่ม ครับ
ผม เพิ่งเจอข้อมูลเกี่ยวกับ เรื่องที่เกี่ยวข้อง
ซึ่งอยู่ที่ เกมสล็อตแตกง่าย
สำหรับใครกำลังหาเนื้อหาแบบนี้
มีการยกตัวอย่างที่เข้าใจง่าย
ขอบคุณที่แชร์ บทความคุณภาพ นี้
และหวังว่าจะมีข้อมูลใหม่ๆ มาแบ่งปันอีก