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.
Mercedes Sprinter rentals in Dubai and UAE provide top-class comfort for group travel. With spacious interiors, Sprinter vans are ideal for events or corporate use. Rent the best Mercedes Sprinter in Dubai for premium transportation across the UAE.
It’s one of the most luxurious destinations in the world, and when you want to get around this captivating city, it pays to book a chauffeur!
Experience hassle-free travel from Welland to Toronto and vice versa with Central Taxi. Offering reliable service, including transportation from Welland to Pearson Airport.
Affordable Airport Taxi London delivers exceptional service from London to Toronto Pearson Airport. Our reliable Toronto Pearson Airport shuttle and executive taxi options provide stress-free travel. Book London Ontario Airport Taxi for premium London to Toronto Pearson transfers and experience the best in airport transportation services tailored to your needs.
Top Airport Taxi St. Catharines for reliable transfers. Enjoy Taxi Service from St. Catharines to Toronto Pearson, Buffalo, and Niagara Falls Airports. Our affordable and comfortable St. Catharines Taxi to Airport ensures a pleasant experience. Reserve your ride today!
Count on efficient brampton airport taxi service with expert drivers and clean rides. From brampton to airport, we provide tailored airport transportation services Brampton and premium airport transfers Brampton at great rates.
We are a private hire car company, specializing in passenger transfers to and from Bahamas airports, ports, Bahamas train stations, and Bahamas Places.
Airport Transfer Nassau is a premier transportation provider on the island of New Providence. Our staff are friendly and professional, and our vehicles comfortable and safe.
Discover reputable bus companies in Maryland offering reliable group transportation services. Whether for corporate events or leisure outings, Maryland’s transportation options ensure seamless journeys. Elevate your experience with KV Limo, which offers luxurious transportation solutions for various needs.
Celebrate life with Miami Party Bus Service. From Bachelor Party Buses to Girls\u2019 Night Out, we offer affordable luxury transportation tailored to your needs. Book your Sweet 16 Party Bus or Wedding Party Bus in Miami today for an unforgettable experience!
Party in style with the Best Bachelorette Party Bus Deals in Miami! Our Miami Party Bus for Bachelorette and Bachelor Parties guarantees luxury, fun, and safety, complete with plush seating, LED lighting, and top-tier sound systems for a memorable night.
Experience luxury with our Limo Service Nassau Airport. Offering private transfers to iconic destinations such as Atlantis, Burj Khalifa, and Paradise Island, we ensure that your ride is as comfortable as it is stylish. Whether it’s a Taxi to Nassau Airport from Atlantis or Private Shuttle Nassau Bahamas, we’ve got you covered.
WebSite: https://repaircddvd.com
RepairCdDvD is professional information recuperation software program specializing in repairing and improving statistics from damaged or scratched CD and DVD discs. Here are a few key points approximately RepairCdDvD: Features: Information restoration: RepairCdDvD lets in you to recover records from unreadable CD and DVD discs. Record gadget support: this system works with various document structures, such as UDF (usually used for storing information on DVDs). Photo advent: RepairCdDvD reads information from damaged discs and creates an picture report that may be used for statistics restoration. Coping with photo Discs: even if the disc is a extracted, RepairCdDvD can recover information. Other Media support: the program also can get better data from CD/DVD disks. Conversion to ISO format: It allows growing virtual disc copies (ISO pics) for less difficult recuperation inside the destiny. Transportable model: RepairCdDvD is to be had as a transportable version, allowing you to apply it on one of a kind computers without installation. Velocity and convenience: RepairCdDvD offers an intuitive interface and powerful algorithms, making it clean to experiment and get better statistics with out useless complications. In case you need to get better records from CD and DVD discs, RepairCdDvD is a useful device. Its support for various document structures and photograph introduction skills makes it a effective solution for records restoration. No accrued value in case you need more than one kind media or report machine supported. RepairCdDvD is a quite specialized yet smooth to use media facts recuperation device. It supports all disc codecs and all common document structures. Insert a disc, begin up RepairCdDvD and pick the pressure or media (if no longer selected already) and let RepairCdDvD mount the media. RepairCdDvD immediately shows you all the walls or tracks and sessions located on the media, mixed with all report structures which might be gift. This way you get clean access, similar to explorer, to all the files and folders per report device. As opposed to being constrained to one document system that the OS choices for you, you’ve got get admission to. Get entry to records from older periods or hidden partitions, get right of entry to information that your OS (e.G. Home windows) does now not see or hides from you etc. Integrate this all-revealing functionality with some distance higher examine and healing mechanisms, scanning for lost files functionality, workarounds for a wide variety of power and software bugs, boundaries or shortcomings and you’ve got an exceedingly powerful data restoration tool. RepairCdDvD is should-have-software for every pc user and is intentionally stored low-priced a good way to provide a solution for each person.Shape of the medium, facts recording Micrograph of recesses and fields Diagram of a go-phase of a pressed plate A trendy compact disc, often known as an audio CD, stores the digital audio record in a “crimson ebook” preferred to differentiate it from later variations. Compact discs are product of a 1.2 mm thick polycarbonate plate with a diameter of 12 cm, protected with a skinny layer of aluminum (aluminum), wherein information is contained (inside the form of a mixture of micro-grooves and places with out them). They are examine with a semiconductor laser (AlGaAs) with a wavelength of about 780 nm. The recording creates a spiral course from the center to the edge of the document.The rotational speed of the plate is numerous such that the linear velocity of the read head with admire to the song is constant and for the studying pace x1 it’s miles in the range of 1.2 to 1.Four ms. The disc is study from the center to the out of doors, and the rotational speed decreases as you move away from the center of the disc.Before writing to disk, facts is encoded inside the “8 in 14” widespread and stored in the form of land and pits. Inside the embossed plates, the recesses are 1/four wavelength deep within the cloth of the analyzing laser plate (about a hundred twenty five nm), as a result of the interference of light meditated from the environment and the recesses, the wave is extinguished. The pits are 500 nm extensive and the track spacing is 1.6 mm. The variations in light reflection are utilized by the lens servo to manual the beam along the route and focus it.The “8 in 14” coding machine guarantees that the smallest pit and land length is three bits (833 nm) and the longest 11 bits (3560 nm) WebSite: https://repaircddvd.com
WebSite: https://repaircddvd.com
Travel stress-free with Brantford Taxi & Shuttle Services. We provide top-notch airport transfers, including Brantford to Toronto Pearson Airport Taxi, luxury limo services, and budget-friendly shuttles to Hamilton and Buffalo, ensuring reliability and convenience every time.
在这个网站上，您可以找到专门从事临时的高危工作的专业人士。
我们提供大量技能娴熟的工作人员供您选择。
不管是何种复杂情况，您都可以轻松找到胜任的人选。
如何在网上下令谋杀
所有合作人员均经过筛选，保证您的安全。
服务中心注重效率，让您的个别项目更加高效。
如果您需要服务详情，请与我们取得联系！
Этот сайт — аутентичный онлайн-магазин Bottega Венета с отгрузкой по стране.
У нас вы можете купить оригинальные товары Bottega Veneta без посредников.
Все товары подтверждены сертификатами от марки.
bottega veneta очки
Перевозка осуществляется быстро в по всей территории России.
Наш сайт предлагает выгодные условия покупки и гарантию возврата средств.
Положитесь на официальном сайте Bottega Veneta, чтобы быть уверенным в качестве!
https://www.youtube.com/channel/UCyt2dGrKTf9KpBk1jdUl3oA
This website makes it possible to hire workers for temporary dangerous jobs.
Clients may efficiently arrange support for specific operations.
Each professional have expertise in handling complex operations.
hitman for hire
This service ensures private interactions between users and freelancers.
For those needing a quick solution, our service is the right choice.
Create a job and match with the right person in minutes!
Наличие страхового полиса перед поездкой за рубеж — это обязательное условие для финансовой защиты туриста.
Страховка гарантирует неотложную помощь в случае несчастного случая за границей.
К тому же, страховка может включать оплату на медицинскую эвакуацию.
мед страховка для поездки за границу
Ряд стран обязывают наличие страховки для посещения.
При отсутствии полиса медицинские расходы могут быть финансово обременительными.
Приобретение документа заблаговременно
Предстоящее лето обещает быть насыщенным и оригинальным в плане моды.
В тренде будут асимметрия и минимализм с изюминкой.
Актуальные тона включают в себя мягкие пастели, выделяющие образ.
Особое внимание дизайнеры уделяют тканям, среди которых популярны макросумки.
https://telegra.ph/5-luchshih-sumok-Coccinelle-na-ehtu-vesnu-03-31
Возвращаются в моду элементы нулевых, в свежем прочтении.
В новых коллекциях уже можно увидеть смелые решения, которые поражают.
Будьте в курсе, чтобы встретить лето стильно.
https://www.youtube.com/channel/UCyt2dGrKTf9KpBk1jdUl3oA
Pingback: 1xbet
https://www.youtube.com/channel/UCyt2dGrKTf9KpBk1jdUl3oA
On this platform, you can access a wide selection of online slots from leading developers.
Players can try out retro-style games as well as feature-packed games with stunning graphics and bonus rounds.
Even if you’re new or an experienced player, there’s always a slot to match your mood.
casino slots
Each title are ready to play 24/7 and optimized for PCs and tablets alike.
No download is required, so you can jump into the action right away.
Site navigation is easy to use, making it simple to browse the collection.
Join the fun, and enjoy the thrill of casino games!
This page showcases CD/radio/clock combos made by top providers.
Browse through sleek CD units with PLL tuner and two alarm settings.
These devices offer auxiliary inputs, USB ports, and power outage protection.
Our range ranges from budget-friendly options to high-end designs.
cd player alarm clock
All devices include snooze buttons, rest timers, and digital displays.
Buy now using Walmart links with free shipping.
Find the perfect clock-radio-CD setup for kitchen daily routines.
The site features buggy hire across the island.
Visitors can easily reserve a machine for adventure.
In case you’re looking to explore coastal trails, a buggy is the ideal way to do it.
https://rentry.co/rmwfrtvu
All vehicles are safe and clean and offered in custom rentals.
Booking through this site is user-friendly and comes with clear terms.
Start your journey and enjoy Crete in full freedom.
RepairCdDvD is professional information recuperation software program specializing in repairing and improving statistics from damaged or scratched CD and DVD discs. Here are a few key points approximately RepairCdDvD: Features: Information restoration: RepairCdDvD lets in you to recover records from unreadable CD and DVD discs. Record gadget support: this system works with various document structures, such as UDF (usually used for storing information on DVDs). Photo advent: RepairCdDvD reads information from damaged discs and creates an picture report that may be used for statistics restoration. Coping with photo Discs: even if the disc is a extracted, RepairCdDvD can recover information. Other Media support: the program also can get better data from CD/DVD disks. Conversion to ISO format: It allows growing virtual disc copies (ISO pics) for less difficult recuperation inside the destiny. Transportable model: RepairCdDvD is to be had as a transportable version, allowing you to apply it on one of a kind computers without installation. Velocity and convenience: RepairCdDvD offers an intuitive interface and powerful algorithms, making it clean to experiment and get better statistics with out useless complications. In case you need to get better records from CD and DVD discs, RepairCdDvD is a useful device. Its support for various document structures and photograph introduction skills makes it a effective solution for records restoration. No accrued value in case you need more than one kind media or report machine supported. RepairCdDvD is a quite specialized yet smooth to use media facts recuperation device. It supports all disc codecs and all common document structures. Insert a disc, begin up RepairCdDvD and pick the pressure or media (if no longer selected already) and let RepairCdDvD mount the media. RepairCdDvD immediately shows you all the walls or tracks and sessions located on the media, mixed with all report structures which might be gift. This way you get clean access, similar to explorer, to all the files and folders per report device. As opposed to being constrained to one document system that the OS choices for you, you’ve got get admission to. Get entry to records from older periods or hidden partitions, get right of entry to information that your OS (e.G. Home windows) does now not see or hides from you etc. Integrate this all-revealing functionality with some distance higher examine and healing mechanisms, scanning for lost files functionality, workarounds for a wide variety of power and software bugs, boundaries or shortcomings and you’ve got an exceedingly powerful data restoration tool. RepairCdDvD is should-have-software for every pc user and is intentionally stored low-priced a good way to provide a solution for each person.Shape of the medium, facts recording Micrograph of recesses and fields Diagram of a go-phase of a pressed plate A trendy compact disc, often known as an audio CD, stores the digital audio record in a “crimson ebook” preferred to differentiate it from later variations. Compact discs are product of a 1.2 mm thick polycarbonate plate with a diameter of 12 cm, protected with a skinny layer of aluminum (aluminum), wherein information is contained (inside the form of a mixture of micro-grooves and places with out them). They are examine with a semiconductor laser (AlGaAs) with a wavelength of about 780 nm. The recording creates a spiral course from the center to the edge of the document.The rotational speed of the plate is numerous such that the linear velocity of the read head with admire to the song is constant and for the studying pace x1 it’s miles in the range of 1.2 to 1.Four ms. The disc is study from the center to the out of doors, and the rotational speed decreases as you move away from the center of the disc.Before writing to disk, facts is encoded inside the “8 in 14” widespread and stored in the form of land and pits. Inside the embossed plates, the recesses are 1/four wavelength deep within the cloth of the analyzing laser plate (about a hundred twenty five nm), as a result of the interference of light meditated from the environment and the recesses, the wave is extinguished. The pits are 500 nm extensive and the track spacing is 1.6 mm. The variations in light reflection are utilized by the lens servo to manual the beam along the route and focus it.The “8 in 14” coding machine guarantees that the smallest pit and land length is three bits (833 nm) and the longest 11 bits (3560 nm) WebSite: https://repaircddvd.com
https://www.youtube.com/channel/UCyt2dGrKTf9KpBk1jdUl3oA
Pingback: เว็บพนันออนไลน์เกาหลี
https://www.youtube.com/channel/UCyt2dGrKTf9KpBk1jdUl3oA
The digital drugstore offers an extensive variety of pharmaceuticals for budget-friendly costs.
You can find both prescription and over-the-counter medicines for all health requirements.
Our goal is to keep safe and effective medications without breaking the bank.
Quick and dependable delivery provides that your purchase gets to you quickly.
Take advantage of ordering medications online through our service.
ajanta tadalis
Did you know that nearly 50% of patients experience serious drug mistakes because of poor understanding?
Your physical condition is your most valuable asset. All treatment options you consider significantly affects your long-term wellbeing. Maintaining awareness about medical treatments should be mandatory for successful recovery.
Your health goes far beyond taking pills. Each drug changes your physiology in unique ways.
Never ignore these essential facts:
1. Mixing certain drugs can cause fatal reactions
2. Seemingly harmless pain relievers have potent side effects
3. Self-adjusting treatment undermines therapy
For your safety, always:
✓ Verify interactions with professional help
✓ Study labels thoroughly before taking medical treatment
✓ Ask your pharmacist about proper usage
___________________________________
For verified drug information, visit:
https://www.hr.com/en/app/calendar/event/nizagara-comprehensive-review-and-comparison-with-_ltj3ifw5.html
On this platform, you can discover lots of slot machines from leading developers.
Visitors can experience traditional machines as well as new-generation slots with stunning graphics and bonus rounds.
If you’re just starting out or a seasoned gamer, there’s something for everyone.
money casino
All slot machines are ready to play 24/7 and compatible with laptops and smartphones alike.
You don’t need to install anything, so you can jump into the action right away.
Platform layout is user-friendly, making it quick to find your favorite slot.
Register now, and enjoy the world of online slots!
WebSite: https://repaircddvd.com
https://www.youtube.com/channel/UCyt2dGrKTf9KpBk1jdUl3oA
Traditional timepieces will continue to be in style.
They symbolize tradition and provide a mechanical beauty that digital devices simply fail to offer.
Each piece is powered by tiny components, making it both useful and artistic.
Timepiece lovers cherish the craft behind them.
https://fashionpromo.ru/look/533-novye-tsveta-i-razmery-dlya-kollektsii-conquest/
Wearing a mechanical watch is not just about checking hours, but about celebrating tradition.
Their styles are timeless, often passed from lifetime to legacy.
Ultimately, mechanical watches will stand the test of time.
Pingback: kliknij, aby uzyskać więcej informacji
Pingback: ผู้ผลิต โบลเวอร์
Your article helped me a lot, is there any more related content? Thanks!
On this platform, you can find a great variety of casino slots from top providers.
Visitors can experience traditional machines as well as feature-packed games with high-quality visuals and exciting features.
Even if you’re new or a casino enthusiast, there’s a game that fits your style.
money casino
Each title are available round the clock and compatible with laptops and tablets alike.
No download is required, so you can jump into the action right away.
Site navigation is easy to use, making it quick to browse the collection.
Register now, and discover the excitement of spinning reels!
Pingback: ufa789
I’m truly impressed by your keen analysis and excellent way of expressing complex ideas. Your depth of knowledge clearly stands out in each paragraph. It’s clear that you put a lot of effort into delving into your topics, and that effort pays off. We appreciate your efforts in sharing this valuable knowledge. Keep up the great work! Learn more about our OnlyFans Agency: https://elevenviral.com/onlyfans-marketing-growth-service/
Hi to all, it’s in fact a pleasant for me to pay a
visit this site, it includes valuable Information.
이태원게이바
충무로출장업소
I love what you guys tend to be up too. This sort of clever work and exposure!
Keep up the excellent works guys I’ve included you guys to blogroll.
Salutes , peer subscriber. I stumbled upon your pensive feedback on the
blog content highly penetrating.
Your perspective on the matter is somewhat impressive .
As you come across to maintain a devoted investment
in the area, I aim to offer an call for you to delve into the domain of ‘918KISS’.
The website offers a abundant portfolio of riveting data that in turn address
persons encompassing multifaceted interests .
I think you might encounter the network at ‘918KISS’ to be equally meaningful and cognitively enthralling .
I encourage you to ponder affiliating with us and delivering your unparalleled
understandings to the ongoing dialogues
. Eagerly awaiting possibly integrating you aboard .
Check out my web blog :: online casino tournaments
Pingback: Dew Drop – February 16, 2024 (#4130) – Morning Dew by Alvin Ashcraft