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.
Yes! Finally someone writes about mafia168.
Discover a tale of rivalry and revenge. This novel is packed with action and emotion. The PDF version is easy to read. Download it now and see how the story of the wife and the other woman plays out. https://myhusbandswifepdf.top/ My Husband’s Wife Sell
Discover the beautifully written novel in a convenient digital file. The PDF of It Should Have Been You is easy to read. It should have been you admiring the style. Download the ebook now and enjoy. https://itshouldhavebeenyoupdf.top/ It Should Have Been You Free Ebook
คอนเทนต์นี้ อ่านแล้วเพลินและได้สาระ ค่ะ
ดิฉัน เพิ่งเจอข้อมูลเกี่ยวกับ เนื้อหาในแนวเดียวกัน
ซึ่งอยู่ที่ สมัคร megagame888
ลองแวะไปดู
มีตัวอย่างประกอบชัดเจน
ขอบคุณที่แชร์ เนื้อหาดีๆ นี้
และอยากเห็นบทความดีๆ แบบนี้อีก
Are you ready for a shock? This book delivers unexpected turns in every chapter. It focuses on the fragile nature of a marriage. Get the My Husband’s Wife PDF and immerse yourself in a story that brilliantly portrays the complexities of human emotion and deceit. https://myhusbandswifepdf.top/ My Husband’s Wife Mystery Novel Pdf
Good posts. Cheers! https://freedman-bendsen-2.thoughtlanes.net/phaaaipruucchak-sl-tsaayethirn-ainyukh-nailn
You said that fantastically! https://pad.geolab.space/s/Z1JAHzY33
The magic is calling you. An Arcane Inheritance is the answer, available in PDF. This digital novel is irresistible. Download the file now and answer the call of the arcane inheritance. https://anarcaneinheritancepdf.top/ An Arcane Inheritance Pdf Mirror
Hey Merci pour le bon moment sur ce site. Continuez comme ça.
On revient toujours volontiers .
A story of hidden powers and family betrayals. The An Arcane Inheritance PDF delivers high-stakes drama. This digital edition is perfect for binge-reading. Secure your copy now and discover the truth behind the inheritance that everyone is killing to possess. https://anarcaneinheritancepdf.top/ An Arcane Inheritance Pdf Free Direct Download
I love the efficiency of digital searching. If I want to find a specific quote, I can search the PDF from an archive of romance in seconds. This is much faster than flipping through hundreds of paper pages to find that one line I loved. https://anarchiveofromancepdf.top/ An Archive Of Romance Free Download
Hello! I know this is somewhat off-topic however I needed
to ask. Does managing a well-established website such as yours take
a lot of work? I am brand new to writing a blog however I do write
in my journal every day. I’d like to start a blog so I can share
my own experience and feelings online. Please let me know if you have any suggestions or tips for new aspiring bloggers.
Appreciate it!
I love how digital books don’t gather dust. An archive of romance provides a clean and allergy-free reading experience. I can enjoy my vintage romance novels in PDF format without the sneezing fits that come with handling old, dusty paperbacks. https://anarchiveofromancepdf.top/ An Archive Of Romance Pdf File
Witness battles that are as much about inner demons as external threats. https://heiroffirepdf.top/ Manon Heir Of Fire
The Lights Out PDF on our site is verified for quality and completeness. You won’t find any corrupted pages or missing chapters here. It is the reliable download you need for peace of mind. https://lightsoutpdf.top/ Can Led Lights Burn Out
Get the Lights Out PDF from a team that cares about digital preservation. We ensure the file quality remains high over time. accurate, clear, and lasting – that is what we deliver. https://lightsoutpdf.top/ When Did Led Lights Come Out
Premium watches continue to remain popular despite the rise of modern gadgets.
They are often seen as a symbol of status and refined taste.
Expert workmanship plays a major role in their lasting value.
Many luxury watches are produced using high-quality materials.
https://wowon.free.nf/read-blog/93
They also represent a deep history passed down through generations.
For collectors, these watches can serve as both practical items and valuable assets.
Classic aesthetics allows them to stay relevant across changing fashion trends.
Ultimately, luxury watches continue to interest buyers around the world.
Premium watches continue to hold strong appeal despite the rise of modern gadgets.
They are often seen as a sign of prestige and refined taste.
Craftsmanship plays a major role in their lasting value.
Many luxury watches are produced using premium components.
https://penzu.com/p/0531ccde90c0a154
They also represent a rich heritage passed down through generations.
For collectors, these watches can serve as both practical items and collectible pieces.
Timeless design allows them to stay relevant across changing fashion trends.
Ultimately, luxury watches continue to interest buyers around the world.
High-end timepieces continue to hold strong appeal despite the rise of modern gadgets.
They are often seen as a symbol of status and refined taste.
Expert workmanship plays a major role in their lasting value.
Many luxury watches are produced using carefully selected materials.
https://penposh.com/blogs/476021/ArabicBezel-A-Luxury-Watch-Aggregator-for-the-UAE-and-Middle
They also represent a rich heritage passed down through generations.
For collectors, these watches can serve as both functional accessories and valuable assets.
Classic aesthetics allows them to stay relevant across changing fashion trends.
As a result, luxury watches continue to interest buyers around the world.
Join the millions who have been enchanted by this epic fantasy saga. https://heiroffirepdf.top/ Throne Of Glass Heir Of Fire Pdf
Find the Lights Out PDF you have been waiting for and start reading within seconds. Our streamlined interface removes all the unnecessary steps, getting you to your content faster. It is the perfect solution for busy readers who value their time and data. https://lightsoutpdf.top/ Lights Out Pdf Online Free
Your point of view caught my eye and was very interesting. Thanks. I have a question for you. https://accounts.binance.info/en/register?ref=JHQQKNKN
Dressing stylish projects a positive first impression.
A outfit speaks loudly before you actually say a word.
This boosts your personal self-esteem and mindset noticeably.
A polished appearance signals professionalism in the office.
https://all.megakazan.ru/Q6zDenwO/
Stylish clothing allow you to showcase your unique identity.
Others often judge stylish people as more successful and trustworthy.
Ultimately, investing in your style is an valuable step in yourself.
Looking stylish creates a strong first impression.
Your outfit speaks loudly before you even say a word.
This enhances your personal self-esteem and mood noticeably.
Your polished appearance conveys professionalism in the workplace.
https://s1.superlooks.ru/cz6syZg4ZZ/
Fashionable clothing allow you to express your unique identity.
People often perceive stylish people as more successful and trustworthy.
Ultimately, investing in your style is an valuable step in your personal brand.
A masterpiece of historical fiction is just a click away. The Nightingale PDF is ready for your collection. It is a profound story about the choices we make in the face of evil and the power of hope. https://thenightingalepdf.top/ the nightingale pdf free download
Dressing well creates a strong first impression.
A attire communicates volumes before a person actually say a single word.
It boosts your personal confidence and mood significantly.
A put-together look conveys professionalism in the office.
https://bm6.irkpress.ru/WeyKLQ/
Fashionable clothing allow you to express your individual personality.
People often judge well-dressed people as more successful and reliable.
Ultimately, putting effort in your style is an investment in your personal brand.
คอนเทนต์นี้ อ่านแล้วได้ความรู้เพิ่ม ครับ
ดิฉัน ไปเจอรายละเอียดของ ข้อมูลเพิ่มเติม
ซึ่งอยู่ที่ luck168 brand site
น่าจะถูกใจใครหลายคน
มีตัวอย่างประกอบชัดเจน
ขอบคุณที่แชร์ เนื้อหาดีๆ นี้
และหวังว่าจะได้เห็นโพสต์แนวนี้อีก
Get lost in the pages of a truly epic novel. The Nightingale in PDF offers a seamless reading experience for fans of historical drama. Discover the choices that define us when our world is turned upside down by conflict. https://thenightingalepdf.top/ who wrote the nightingale
Ianthe is a priestess with her own agenda. Watch her schemes unfold in the A Court of Mist and Fury PDF. This digital novel is full of political intrigue. Download it to see who Feyre can truly trust. https://acourtofmistandfurypdf.top/ A Court Of Mist And Fury Rhysand
Dressing stylish creates a strong first impression.
A attire communicates volumes before you even speak a single word.
This enhances your personal self-esteem and mood noticeably.
A put-together appearance conveys professionalism in the office.
https://like.podium24.ru/Xvkivm4tSCw0/
Fashionable clothing let you to express your unique identity.
Others often perceive well-dressed people as more capable and trustworthy.
Ultimately, putting effort in your wardrobe is an investment in yourself.
Dressing well creates a strong first impression.
A attire speaks volumes before you even speak a word.
This boosts your personal confidence and mood significantly.
A put-together appearance conveys competence in the workplace.
https://bookmarks.sochidaily.ru/DNH8R9Xkz/
Stylish clothing allow you to showcase your unique personality.
People often perceive well-dressed people as more capable and reliable.
Therefore, putting effort in your wardrobe is an valuable step in your personal brand.
Looking stylish projects a positive first impression.
A attire communicates loudly before a person even speak a word.
It boosts your personal confidence and mindset noticeably.
Your polished look conveys professionalism in the workplace.
https://a2.megakazan.ru/Se9bmLY/
Stylish clothing let you to showcase your individual identity.
People often judge stylish people as more capable and trustworthy.
Therefore, investing in your wardrobe is an valuable step in your personal brand.
Looking stylish creates a strong first impression.
Your outfit communicates volumes before a person even say a single word.
This enhances your personal self-esteem and mindset noticeably.
Your put-together appearance conveys competence in the office.
https://b4.hypebeasts.ru/MbggbLG/
Fashionable choices allow you to express your unique identity.
Others often judge stylish people as more capable and trustworthy.
Ultimately, putting effort in your wardrobe is an valuable step in your personal brand.
Uncover the secrets of the Nightingale. Download the PDF and start reading today. It is a thrilling and emotional ride through the darkest days of the 20th century, filled with unforgettable characters. https://thenightingalepdf.top/ the nightingale pdf download free
The sensory details in this book are amazing. Experience them with the A Court of Mist and Fury PDF. Sarah J. Maas describes scents and sounds vividly. Download the file to be fully immersed in Prythian. https://acourtofmistandfurypdf.top/ A Court Of Mist And Fury Pdf Book
Looking well creates a strong first impression.
A attire speaks loudly before a person even speak a word.
It boosts your personal confidence and mindset noticeably.
A polished appearance signals competence in the workplace.
https://r2.balmain1.ru/gazTe0I44/
Stylish choices allow you to express your individual personality.
Others often judge stylish people as more successful and reliable.
Therefore, investing in your wardrobe is an investment in yourself.
Looking stylish creates a strong first impression.
A outfit communicates volumes before a person even speak a word.
It enhances your own confidence and mood noticeably.
Your put-together look signals competence in the office.
https://b.balenciager.ru/OLUOQlm/
Fashionable choices let you to express your unique personality.
People often perceive well-dressed people as more capable and reliable.
Ultimately, investing in your style is an valuable step in your personal brand.
You actually make it appear really easy with your presentation but I in finding this
topic to be actually one thing that I think I might never understand.
It kind of feels too complicated and very extensive for me.
I am taking a look ahead to your subsequent submit, I’ll attempt to
get the grasp of it!
I love your blog.. very nice colors & theme. Did you make this website yourself or did you hire someone to do it for you? Plz respond as I’m looking to construct my own blog and would like to know where u got this from. many thanks
The darkness cannot hide the truth. The Onyx Storm epub shines a light. This book is a revelation. Digital copies are the bright choice. You can see the story clearly. Rebecca Yarros illuminates the world.
โพสต์นี้ ให้ข้อมูลดี ครับ
ผม เพิ่งเจอข้อมูลเกี่ยวกับ เนื้อหาในแนวเดียวกัน
ดูต่อได้ที่ betflix19 สล็อตเว็บตรง
ลองแวะไปดู
มีตัวอย่างประกอบชัดเจน
ขอบคุณที่แชร์ บทความคุณภาพ นี้
และหวังว่าจะได้เห็นโพสต์แนวนี้อีก
The anticipation for the next chapter in the dragon rider saga is palpable, with readers counting down the seconds. Onyx Storm promises to answer the burning questions left by the previous cliffhanger, making the epub version a hot commodity. Digital reading allows you to carry the weight of this epic fantasy without the physical bulk. It is the ideal solution for fans who read on the commute or steal moments during a busy day. Rebecca Yarros has crafted a masterpiece that demands your full attention, and having it on your smartphone or tablet ensures you are never far from the action.
The storm is the beginning of the end. The Onyx Storm epub is the start. This book is the origin. Reading on a screen is the modern beginning. You can start now. Rebecca Yarros begins the journey.
Love and war are the two sides of the same coin. The Onyx Storm epub flips that coin. This sequel is a gamble that pays off. Reading on a device is the modern way to enjoy fantasy. You can take the story with you everywhere. Rebecca Yarros wins again.
Офсетная печать — наиболее популярный вид коммерческой печати.
Широкоформатная печать отлично предназначена для быстрых тиражей и индивидуализации.
Трафаретная печать часто используется для нанесения на текстиль и нестандартные материалы.
https://www.intensedebate.com/people/printinghouse2z
Флексография используется в основном для упаковки и изготовления этикеток.
Для внешней рекламы часто используют широкоформатную полиграфию на баннерах.
Отделочная доводка содержит такие операции, как биговка, высечка и фальцовка.
Basgiath is a memory, but the fight is the present. The Onyx Storm epub is the manual for survival. This story is intense and unrelenting. E-readers are the perfect vessel for such a tale. You can get lost in the world for hours. Make sure you have the digital copy ready.
The lightning strikes twice, and it is even more powerful the second time. The Onyx Storm epub is electric. This book will shock you. Digital reading offers the best user experience. You can tailor the text to your needs. Rebecca Yarros is a queen of fantasy. https://onyxstormepub.store/ Onyx Storm Pdf Gratis
When the storm breaks, will you be ready? The Onyx Storm epub ensures that you are. This book is a testament to the power of resilience and love. E-readers provide a sanctuary where you can escape into this rich world. Rebecca Yarros has created a modern classic. Make sure you have the digital file to enjoy it to the fullest. https://onyxstormepub.store/ Onyx Storm Pdf Vk
Right away I am ready to do my breakfast, when having my breakfast coming again to read additional news.
The phenomenon that took the book world by storm returns with even more intensity and danger. Violet Sorrengail’s journey is far from over, and the challenges she faces now threaten the very foundation of her world. Finding the Onyx Storm epub is top of the list for fantasy lovers who want instant access to the story. With the versatility of digital formats, you can carry this massive epic in your pocket, ready to read whenever you have a spare moment. Rebecca Yarros weaves a narrative so compelling that you will want to have it accessible at all times, re-reading the most shocking chapters again and again. https://onyxstormepub.store/ Onyx Storm Free Pdf Free Download