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.
markettrail.click – Mobile version looks perfect; no glitches, fast scrolling, crisp text.
clickmagnetix.click – Appreciate the typography choices; comfortable spacing improved my reading experience.
leadcraft.click – Appreciate the typography choices; comfortable spacing improved my reading experience.
trafficwave.click – Content reads clearly, helpful examples made concepts easy to grasp.
adnectar.click – Found practical insights today; sharing this article with colleagues later.
marketfusion.click – Color palette felt calming, nothing distracting, just focused, thoughtful design.
growthbeacon.click – Found practical insights today; sharing this article with colleagues later.
adorbit.click – Appreciate the typography choices; comfortable spacing improved my reading experience.
Английский сегодня считается важным навыком для современного человека.
Английский язык позволяет взаимодействовать с иностранцами.
Без владения языком сложно строить карьеру.
Организации предпочитают специалистов с языковыми навыками.
интенсивные курсы английского языка в Москве
Обучение английскому открывает новые возможности.
Зная английский, можно читать оригинальные источники без ограничений.
Также, овладение английским повышает концентрацию.
Таким образом, умение говорить по-английски становится ключом в саморазвитии каждого человека.
Английский язык сегодня считается важным инструментом для каждого человека.
Он дает возможность находить общий язык с жителями разных стран.
Не зная английский почти невозможно строить карьеру.
Многие компании оценивают сотрудников, владеющих английским.
интенсивные курсы английского языка в Москве
Регулярная практика английского открывает новые возможности.
Благодаря английскому, можно учиться за границей без перевода.
Помимо этого, регулярная практика улучшает мышление.
Таким образом, владение английским является залогом в саморазвитии каждого человека.
Знание английского языка сегодня считается важным умением для современного человека.
Английский язык дает возможность находить общий язык с иностранцами.
Без владения языком трудно развиваться профессионально.
Организации предпочитают специалистов с языковыми навыками.
экспресс курс английского языка
Изучение языка делает человека увереннее.
С помощью английского, можно путешествовать без перевода.
Также, изучение языка повышает концентрацию.
Таким образом, владение английским становится ключом в будущем каждого человека.
Английский сегодня считается важным навыком для жителя современного мира.
Английский язык помогает взаимодействовать с жителями разных стран.
Без знания английского сложно строить карьеру.
Многие компании требуют специалистов с языковыми навыками.
minutamami.ru
Изучение языка открывает новые возможности.
Благодаря английскому, можно путешествовать без ограничений.
Помимо этого, изучение языка развивает память.
Таким образом, знание английского языка является залогом в саморазвитии каждого человека.
Английский сегодня считается незаменимым умением для жителя современного мира.
Он дает возможность общаться с людьми со всего мира.
Без знания английского сложно развиваться профессионально.
Работодатели требуют сотрудников, владеющих английским.
курсы интенсивного изучения английского
Изучение языка открывает новые возможности.
С помощью английского, можно читать оригинальные источники без трудностей.
Помимо этого, изучение языка развивает память.
Таким образом, владение английским является залогом в саморазвитии каждого человека.
rankpilot.click – Overall, professional vibe here; trustworthy, polished, and pleasantly minimal throughout.
trafficpilot.click – Navigation felt smooth, found everything quickly without any confusing steps.
marketjet.click – Pages loaded fast, images appeared sharp, and formatting stayed consistent.
growthsprint.click – Loved the layout today; clean, simple, and genuinely user-friendly overall.
adrocket.click – Overall, professional vibe here; trustworthy, polished, and pleasantly minimal throughout.
adorbit.click – Mobile version looks perfect; no glitches, fast scrolling, crisp text.
admomentum.click – Found practical insights today; sharing this article with colleagues later.
rankpilot.click – Pages loaded fast, images appeared sharp, and formatting stayed consistent.
marketjet.click – Bookmarked this immediately, planning to revisit for updates and inspiration.
trafficpilot.click – Overall, professional vibe here; trustworthy, polished, and pleasantly minimal throughout.
growthsprint.click – Bookmarked this immediately, planning to revisit for updates and inspiration.
I agree with your points, superb post.
clickfoundry.click – Overall, professional vibe here; trustworthy, polished, and pleasantly minimal throughout.
adexpand.click – Color palette felt calming, nothing distracting, just focused, thoughtful design.
brandecho.click – Navigation felt smooth, found everything quickly without any confusing steps.
leadorbit.click – Mobile version looks perfect; no glitches, fast scrolling, crisp text.
clickfoundry.click – Navigation felt smooth, found everything quickly without any confusing steps.
adexpand.click – Appreciate the typography choices; comfortable spacing improved my reading experience.
trafficzen.click – Navigation felt smooth, found everything quickly without any confusing steps.
growthshift.click – Loved the layout today; clean, simple, and genuinely user-friendly overall.
leadvortex.click – Appreciate the typography choices; comfortable spacing improved my reading experience.
viralaxis.click – Color palette felt calming, nothing distracting, just focused, thoughtful design.
clickmagnet.click – Loved the layout today; clean, simple, and genuinely user-friendly overall.
Английский сегодня считается обязательным умением для современного человека.
Он дает возможность находить общий язык с иностранцами.
Без знания английского сложно достигать успеха в работе.
Организации требуют специалистов с языковыми навыками.
test.fgx-native.com
Регулярная практика английского открывает новые возможности.
С помощью английского, можно учиться за границей без ограничений.
Кроме того, овладение английским повышает концентрацию.
Таким образом, знание английского языка является залогом в будущем каждого человека.
Английский сегодня считается незаменимым инструментом для современного человека.
Он позволяет находить общий язык с иностранцами.
Без знания английского трудно достигать успеха в работе.
Многие компании предпочитают знание английского языка.
обучение английскому в компании
Обучение английскому открывает новые возможности.
Зная английский, можно учиться за границей без перевода.
Помимо этого, регулярная практика повышает концентрацию.
Таким образом, знание английского языка является залогом в успехе каждого человека.
Английский сегодня считается необходимым инструментом для современного человека.
Он помогает находить общий язык с людьми со всего мира.
Без владения языком сложно строить карьеру.
Многие компании предпочитают сотрудников, владеющих английским.
подготовка к toefl в москве
Обучение английскому расширяет кругозор.
С помощью английского, можно путешествовать без трудностей.
Также, регулярная практика повышает концентрацию.
Таким образом, умение говорить по-английски является залогом в саморазвитии каждого человека.
Английский язык сегодня считается необходимым навыком для жителя современного мира.
Английский язык позволяет общаться с иностранцами.
Не зная английский трудно развиваться профессионально.
Работодатели требуют специалистов с языковыми навыками.
https://service-pixel.ru/podgotovka-k-sdache-toefl-s-podderzhkoy-professionalnyh-pedagogov/
Изучение языка расширяет кругозор.
С помощью английского, можно читать оригинальные источники без перевода.
Также, овладение английским развивает память.
Таким образом, знание английского языка является залогом в будущем каждого человека.
Английский сегодня считается необходимым навыком для каждого человека.
Английский язык позволяет взаимодействовать с жителями разных стран.
Без владения языком трудно развиваться профессионально.
Организации предпочитают специалистов с языковыми навыками.
курсы toefl
Изучение языка открывает новые возможности.
Зная английский, можно учиться за границей без перевода.
Также, овладение английским повышает концентрацию.
Таким образом, владение английским играет важную роль в будущем каждого человека.
Знание английского языка сегодня считается незаменимым навыком для каждого человека.
Английский язык дает возможность общаться с жителями разных стран.
Без владения языком сложно развиваться профессионально.
Организации оценивают знание английского языка.
курсы подготовки к toefl
Изучение языка делает человека увереннее.
Благодаря английскому, можно учиться за границей без перевода.
Помимо этого, регулярная практика повышает концентрацию.
Таким образом, знание английского языка является залогом в будущем каждого человека.
Знание английского языка сегодня считается необходимым инструментом для каждого человека.
Он позволяет находить общий язык с людьми со всего мира.
Без знания английского сложно достигать успеха в работе.
Многие компании оценивают специалистов с языковыми навыками.
https://1000nk.ru/iindividualnye-zanyatiya-anglijskogo-kak-vybrat-podhodyashhij-format-i-programmu/
Обучение английскому расширяет кругозор.
Благодаря английскому, можно учиться за границей без ограничений.
Помимо этого, изучение языка улучшает мышление.
Таким образом, владение английским играет важную роль в будущем каждого человека.
Английский язык сегодня считается незаменимым умением для современного человека.
Он дает возможность находить общий язык с иностранцами.
Не зная английский почти невозможно развиваться профессионально.
Организации оценивают сотрудников, владеющих английским.
1000nk.ru
Изучение языка открывает новые возможности.
Благодаря английскому, можно путешествовать без ограничений.
Помимо этого, изучение языка развивает память.
Таким образом, владение английским становится ключом в саморазвитии каждого человека.
Английский сегодня считается необходимым инструментом для современного человека.
Английский язык позволяет общаться с людьми со всего мира.
Не зная английский трудно строить карьеру.
Многие компании требуют знание английского языка.
https://zarazgovorom.ru/bez-rubriki/podgotovka-k-ekzamenu-toefl-onlajn-obzor-formatov-materialov-i-planirovaniya-zanyatij.html
Регулярная практика английского открывает новые возможности.
Зная английский, можно учиться за границей без ограничений.
Кроме того, регулярная практика повышает концентрацию.
Таким образом, умение говорить по-английски играет важную роль в будущем каждого человека.
growthshift.click – Mobile version looks perfect; no glitches, fast scrolling, crisp text.
leadvortex.click – Color palette felt calming, nothing distracting, just focused, thoughtful design.
viralaxis.click – Loved the layout today; clean, simple, and genuinely user-friendly overall.
promostream.click – Overall, professional vibe here; trustworthy, polished, and pleasantly minimal throughout.
clickmagnet.click – Color palette felt calming, nothing distracting, just focused, thoughtful design.