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.
rankseed.click – Just browsed the site, the layout is clean and everything feels nicely organized.
trafficpulse.click – I just visited and the site feels sleek with a very modern clean layout.
seoloom.click – On mobile the site is responsive and everything scales smoothly with no issues.
clicksignal.click – Overall experience is positive; feels like a trustworthy well-built site.
pagevector.click – Already bookmarked it — seems like a resource worth revisiting.
rankmotion.click – Found useful sections quickly, the menu is intuitive and clean.
netfusion.click – Just visited, the design feels crisp and navigation is very smooth.
seoanchor.click – Already bookmarked this, I’ll be back for more content.
Онлайн платформы знакомств позволяют взрослым людям находить друзей в любое время.
Такое общение расширяет кругозор.
Множество людей отмечают, что такие сервисы способствуют расслабиться после работы.
Это понятный вариант для приятных знакомств.
https://ksadm.ru/muzhchina-i-zhenshhina/inczest-porno-mify-interes-i-kulturnyj-kontekst/
Основное — сохранять вежливость и интерес в переписке.
Доброе общение способствует восприятие жизни.
Такие площадки созданы для тех, кто хочет найти новых людей.
Общение через интернет становятся частью отдыха с позитивом.
websummit.click – Navigation is clean, I found what I was looking for instantly.
searchnest.click – Overall the site gives a polished, trustworthy impression today.
ranktrail.click – The site loads fast, I didn’t face any lag while exploring.
ranktrail.click – The color scheme is pleasant, doesn’t distract from the content.
boostcraft.click – I’ve already bookmarked this, seems like a solid resource ahead.
Нейросетевые приложения для обработки изображений являются всё более удобными.
Они используют искусственный интеллект для улучшения качества изображений.
С помощью таких инструментов можно изменить освещение на фото без сложных навыков.
Это делает работу быстрее и предлагает отличный результат.
раздеватор free
Современные пользователи выбирают такие боты для контента.
Они дают возможность создавать привлекательные фотографии даже на смартфоне.
Интерфейс таких систем простое, поэтому с ними легко начать работать.
Совершенствование нейросетей позволяет сделать фотообработку эффективной для всех пользователей.
Нейросетевые онлайн-сервисы для обработки изображений становятся всё более популярными.
Они применяют AI-технологии для улучшения качества изображений.
С помощью таких программ можно изменить освещение на фото без сложных навыков.
Это делает работу быстрее и даёт точную обработку.
раздень по фото
Современные пользователи выбирают такие боты для социальных сетей.
Они дают возможность создавать эстетичные фотографии даже в домашних условиях.
Использование таких систем простое, поэтому с ними быстро разобраться.
Развитие нейросетей превращает фотообработку доступной для широкой аудитории.
webpulse.click – Just browsed a while, the content here feels very polished indeed.
Онлайн сервисы для общения помогают совершеннолетним общаться по интересам.
Такое знакомство расширяет кругозор.
Большинство людей отмечают, что современные платформы способствуют переключиться после ежедневных дел.
Это понятный вариант для новых контактов.
https://ksadm.ru/muzhchina-i-zhenshhina/inczest-porno-mify-interes-i-kulturnyj-kontekst/
Самое важное — сохранять доброжелательность и уважение в диалоге.
Позитивное общение улучшает настроение.
Такие площадки созданы для тех, кто ищет друзей по духу.
Онлайн-знакомства становятся формой досуга с удовольствием.
Современные платформы знакомств помогают пользователям находить друзей в удобном формате.
Такое взаимодействие расширяет кругозор.
Множество людей отмечают, что современные платформы помогают расслабиться после напряжённого дня.
Это простой вариант для приятных знакомств.
https://gaudiya-math.ru/onlajn-razvlecheniya/bdsm-sczeny-s-russkimi-modelyami-populyarnost-i-kultura/
Самое важное — сохранять открытость и искренность в переписке.
Позитивное общение улучшает восприятие жизни.
Такие площадки разработаны для тех, кто ищет новых людей.
Современные сервисы становятся частью отдыха с позитивом.
Интернет платформы знакомств дают возможность пользователям знакомиться в удобном формате.
Такое взаимодействие поднимает настроение.
Множество людей отмечают, что такие сервисы способствуют расслабиться после работы.
Это понятный вариант для приятных знакомств.
https://ksadm.ru/muzhchina-i-zhenshhina/inczest-porno-mify-interes-i-kulturnyj-kontekst/
Самое важное — сохранять доброжелательность и уважение в разговоре.
Позитивное общение способствует настроение.
Такие площадки созданы для тех, кто ищет новых людей.
Общение через интернет становятся частью отдыха с позитивом.
Аренда мебели Прокат мебели качественной мебели для офиса на любой срок. Доставка по Москве и области. Гибкие условия аренды от одного дня.
Наведение порядка в Северной столицы! Жилые помещения, Коттеджи, Офисы. Высококлассный сервис по демократичным тарифам. Больше времени для отдыха! Сделайте заявку очистку в этот день! Жмите https://uborka-top24.ru
http://www.coloredreams.ru Фотозоны в аренду и оригинальные зоны для съемок. Авторский дизайн под любую концепцию.
https://www.coloredreams.ru Круглосуточная поддержка и оперативная помощь клиентам. Помощь в любое время и профессиональное сопровождение.
экстренный вывод из запоя оренбург
vivod-iz-zapoya-orenburg012.ru
вывод из запоя круглосуточно
Капельница от запоя – это значимый метод помощи алкогольной зависимости, что находит свое применение в наркологических клиниках Тулы. Процедура детоксикации помогает оперативному реабилитации организма после длительного потребления алкоголя. Длительность капельницы обычно составляет от одного до трех часов, исходя из особенностей пациента и интенсивности запойного состояния. лечение запоя тула Симптоматика запоя включает в себя сильные головные боли, тошноту и рвоту, обильное потоотделение и тревогу и беспокойство. Помощь врачей в виде капельницы даёт возможность быстро облегчить похмельные симптомы, вводя жизненно важные вещества для восстановления водно-электролитного баланса и выведения токсинов из организма. Стоимость лечения запоя в Туле различается в зависимости от обраной лечебной организации и количества требуемых процедур. Консультация нарколога поможет выработать оптимальный план лечения, включая реабилитацию после запоя. Результативность капельницы подтверждается множество положительными отзывами пациентов, что делает ее популярным способом профилактики с алкоголизмом.
Аренда столов и стульев Широкий ассортимент банкетной мебели для свадеб. Доступные цены, качественная мебель.
Contemporary online platforms for grown users feature a variety of interactive features.
These sites are designed for social interaction and sharing ideas.
Participants can connect with others who enjoy the same hobbies.
Many of these resources focus on safe interaction and positive communication.
https://pietrzyk.us/lifestyle/amateur-gangbang-understanding-the-category-and-its-appeal/
The interface is usually simple, making it easy to navigate.
Such platforms enable people to express themselves in a free online environment.
Security remains an key part of the user experience, with many sites implementing control tools.
Overall, these platforms are designed to support mature interaction in a responsible digital space.
Contemporary digital spaces for adult audiences feature a range of interesting content.
These sites are designed for meeting new people and exploring ideas.
Participants can find others who enjoy the same values.
A lot of of these resources promote respectful interaction and welcoming communication.
https://poweroften.us/online-platforms/foot-fetish-understanding-one-of-the-most-recognized-fetishes/
The layout is usually simple, making it easy to browse.
Such platforms help people to express themselves in a relaxed online environment.
Safety remains an essential part of the user experience, with many sites providing control tools.
Overall, these platforms are created to support mature interaction in a responsible digital space.
Popular online platforms for adult audiences provide a selection of engaging features.
These platforms are designed for communication and sharing lifestyles.
Users can discover others who enjoy the same values.
Most of these services focus on comfortable interaction and welcoming communication.
https://pietrzyk.us/lifestyle/amateur-gangbang-understanding-the-category-and-its-appeal/
The design is usually simple, making it easy to browse.
Such platforms enable people to explore interests in a relaxed online environment.
Security remains an key part of the user experience, with many sites implementing moderation.
Overall, these platforms are created to support open discussion in a respectful digital space.
Аренда event мебели Стильное оформление для конференций. Функциональные и практичные решения для бизнеса.
http://www.coloredreams.ru Актуальные предложения и использование инноваций в мебельной индустрии. Инновационные подходы и свежие решения.
https://www.coloredreams.ru Интерактивный каталог и расширенная сортировка по параметрам. Экономьте время с интуитивным интерфейсом.
https://www.coloredreams.ru Непрерывное обслуживание и мгновенный ответ клиентам. Мгновенная помощь и экспертная консультация по всем вопросам.
http://www.coloredreams.ru Быстрое оформление заказа онлайн в пару кликов. Срочный ответ и моментальная реакция по заявкам.
Fine-art photography often focuses on expressing the beauty of the body lines.
It is about composition rather than appearance.
Professional photographers use subtle contrasts to convey emotion.
Such images celebrate authenticity and character.
https://xnudes.ai/
Each photo aims to evoke feelings through movement.
The goal is to portray human beauty in an artful way.
Audiences often admire such work for its depth.
This style of photography blends emotion and sensitivity into something truly unique.
Аренда банкетной мебели Классические решения для банкетных залов. Огромный ассортимент в наличии, регулярное обновление.
https://coloredreams.ru Рекомендации партнеров и фотоотчеты мероприятий. Контроль состояния и проверка мебели.
Аренда мебели Широкий выбор качественной мебели для дома на любой срок. Доставка по Москве и области. Выгодные тарифы аренды от одного дня.
Creative photography often focuses on revealing the harmony of the natural shape.
It is about expression rather than surface.
Experienced photographers use soft lighting to convey atmosphere.
Such images emphasize authenticity and individuality.
https://xnudes.ai/
Each photo aims to show emotion through form.
The purpose is to show inner grace in an respectful way.
Viewers often admire such work for its creativity.
This style of photography unites art and vision into something truly unique.
Artistic photography often focuses on revealing the harmony of the natural shape.
It is about composition rather than surface.
Experienced photographers use subtle contrasts to create mood.
Such images celebrate authenticity and personality.
https://xnudes.ai/
Every shot aims to show emotion through form.
The goal is to show inner grace in an respectful way.
Audiences often appreciate such work for its emotional power.
This style of photography combines technique and sensitivity into something truly unique.
Мебель для мероприятий Современное оснащение поможет создать уютные условия для всех участников вашего события.
Fine-art photography often focuses on expressing the beauty of the body lines.
It is about light rather than appearance.
Skilled photographers use subtle contrasts to convey mood.
Such images capture artistry and character.
https://xnudes.ai/
Every shot aims to show emotion through form.
The goal is to portray inner grace in an artful way.
Audiences often appreciate such work for its emotional power.
This style of photography combines technique and vision into something truly timeless.
https://ampaints.ru Наш полный гайд поможет вам арендовать качественно всё необходимое для мероприятия. Детали по ссылке.
https://ampaints.ru Изучите с большим ассортиментом мебели для любых типов мероприятий.
https://ampaints.ru Для подготовки свадьбы арендуйте всё необходимое заранее.
https://ampaints.ru Для оформления банкета арендуйте всё необходимое оборудование.
This site offers tons of engaging and valuable content.
On this site, you can find various sections that touch upon many important themes.
All materials is written with attention to clarity.
The content is frequently renewed to keep it up-to-date.
Readers can gain something new every time they visit.
It’s an excellent place for those who appreciate educational reading.
Numerous users find this website to be trustworthy.
If you’re looking for well-written information, you’ll certainly discover it here.
https://clictopics.com
This site offers plenty of engaging and useful content.
On this platform, you can explore various sections that include many relevant fields.
All materials is prepared with attention to clarity.
The content is regularly updated to keep it up-to-date.
Readers can learn useful insights every time they visit.
It’s a wonderful resource for those who enjoy thoughtful reading.
Many people find this website to be well-organized.
If you’re looking for relevant articles, you’ll surely discover it here.
https://cbeachsdsu.com
The platform offers tons of captivating and helpful materials.
On this platform, you can discover a wide range of topics that touch upon many relevant themes.
Every post is written with focus to accuracy.
The content is constantly renewed to keep it relevant.
Visitors can gain fresh knowledge every time they visit.
It’s an excellent place for those who appreciate informative reading.
Numerous users consider this website to be trustworthy.
If you’re looking for well-written articles, you’ll definitely discover it here.
https://cerkes.net