Сегодня заводские съемники представлены на рынке широким выбором моделей. Но если вы являетесь владельцем токарного станка, газовой и электросварки, материала, и у вас есть желание, то съемник вполне реально сделать самостоятельно. Это будет долговечный инструмент, который будет полезен на протяжении десятков лет.

Съемник необходимо делать трех-лапчатым. Это самый удобный вариант. Я напишу размеры инструментов, которыми я пользовался много раз в процессе ремонтов.

Для изготовления самодельного приспособления для подшипников, нужно подобрать следующие материалы:
• гаечный ключ – пара штук;
• пластины из металла, небольших размеров – 4 шт.;

Как именно изготовлять самоделку показано на этих фотографиях

дровокол, актуатор, съемник пружин, струбцина (инструкции)

Дровокол из гидравлического домкрата

1. Двутавровая балка 10, длиной от 1250 мм (для боковых упоров и центральной части).
2. Лист металла, толщиной от 6 мм, площадью от 0.5 м² (для колуна, крепления пружин и упорной насадки на домкрат).
3. Пружины растяжения: 2 шт (для возврата упора домкрата).
4. Труба под диаметр упора домкрата с толщиной стенок от 2-х мм (для надежной установки насадки).
5. Отрезок трубы под диаметр корпуса домкрата: 2 шт по 20 мм (для крепления на каркасе).
6. Шпильки или длинные болты (для стягивания хомутов из отрезков труб).
7. Крюк с резьбой: 2 шт (для крепления пружин к нижней части).
8. Гайки для шпилек и крюков
9. Гидравлический домкрат от 3 тонн

По инструментам:

• Сварочный аппарат
• Болгарка
• Дрель или сверлильный станок

Струбцина из ромбического домкрата

Съемник пружин из жигулевского домкрата

1. Профильная труба по размерам домкрата (для увеличения высоты устройства).
2. Листовой металл от 7 мм (для изготовления верхнего и нижнего крепежа).
3. Массивная металлическая пластина (для основы).
4. Штатный винтовой домкрат ВАЗ 2101-07

• Болгарка
• Сварочный аппарат

Актуатор из штатного домкрата ВАЗ

1. Штатный домкрат ВАЗ 2101-07, 2121 или 21213.
2. Электромотор от стеклоподъемника.
3. Профильная труба 20×20 (будет в качестве выдвижного штока).
4. Листовой металл, от 1 мм (для изготовления заглушки на мотор).
5. Подшипник 302 (6302).
6. Поршневой палец (для изготовления втулки под подшипник).
7. Стопорные кольца (для фиксации подшипника на втулках).
8. Труба с внешним Ø 43 мм, толщиной в 2 мм (для упора подшипника).
9. Труба с внешним Ø 48 мм, толщиной в 2 мм (для боковой фиксации подшипника).
10. Отрезок профильной трубы 10×10 мм (для соединения винта со шкивом электромотора).

• Сварочный аппарат
• Болгарка
• Дрель или сверлильный станок

пошаговая инструкция и рекомендации. Съемник пружин своими руками Приспособление для сжатия пружины амортизатора своими руками

Одной из основных процедур при ремонте передней подвески является замена стоек. Это относится к автомобилям с подвеской Макферсон, когда стойка собрана. То есть стойка представляет собой амортизатор, пружину и опору с чашкой. Все это закреплено гайкой, которая накручена на стержень амортизатора. В итоге стойка находится в постоянной «боевой готовности», когда на сжатие работает пружина, а на растяжение амортизатор.

Но в этой статье мы хотим рассказать не о работе стоек, а о том, как трудно порой приходится автолюбителям при снятии пружины. Все дело в том, что пружина на стойке довольно мощная, а значит усилие ее сжатие очень большое. В итоге, при раскручивании гайки на штоке пружина может «стрельнуть», что может привести к травме. Да к тому же еще и при обратной сборке встанет вопрос о том, как же собрать стойку обратно, то есть сжать пружину. В помощь автолюбителям в этом случае предлагаются в основном всевозможные съемники пружин. Обычно это система шпилек с крючками или шайбами. В итоге стягивание пружин происходит за счет скручивания гайки по шпильке. Этот способ снятия пружиня вполне жизненный, однако и имеет свои недостатки. Основным из которых является большое время на закручивание раскручивание гаек по шпильке. В этой статье мы хотели бы вам предложить другую альтернативу, прекрасно справляющуюся с этой задачей, при этом требующую от механика гораздо меньших усилий.

Приспособление для быстрой разборки стоек, замены (сжатия) пружины на них в гараже своими руками

Принцип работы этого приспособления основан на увеличении крутящего момента за счет изменения плеча приложения силы. Можно сказать классическое решение для большинства случаев в механике. Так точками опоры будет стена, к которой консолью приделано плечо и стойка вернее пружина. Здесь усилия прилагаемые на стойку будут зависеть от длины рычага плеча. Фактически это ручки нашего приспособления. На них можно просто присесть и человеческого веса вполне хватит для того, чтобы сжать пружину. Взгляните на рисунок.

А теперь по порядку, как будет происходит замена, снятие пружины со стойки. Первоначально необходимо развести плечи приспособления и установить на чашку над пружиной. Далее сводим плечи между собой фиксируем, например отрезком трубы.

Дале просто садимся на трубу и тем самым сдавливаем пружину. Усилие на пружину можно регулировать собственным телом, садясь на рычаге чуть дальше или ближе к стойке. Откручиваем гайку, удерживающую поворотную опору и чашку пружины.

Аккуратно встаем, тем самым снимая напряжение сжатия на самой пружине, которая еще установлена на стойке. После распрямления пружины снимаем ее со стойки.

Установку и сжатие новой пружины производим в обратной последовательности.

Резюмируя о съемнике пружин…

Необходимо сказать о том, что применение подобного приспособления оправдано особенно в тех случаях, когда замена пружины на стойках подобного типа происходит часто. В основном это автосервисы. Также надо заметить, что приспособление универсально. На нем можно демонтировать пружины со стоек любых авто, фактически меняя высоту плеча, которым поджимается пружина. Работы связанные со снятием и заменой пружины при применении такого приспособления будут значительно упрощены, что пожалуй является определяющим фактором при решении вопроса о изготовлении чего-то подобного в вашем гараже.

Работоспособность амортизаторов влияет на общее состояние автомобиля очень сильно. Многие автовладельцы, которые хотят здорово сэкономить на техническом обслуживании, самостоятельно выполняют замену таких деталей в домашних условиях. Для профессионалов уже не составляет труда ни замена защиты амортизаторов, ни самих устройств. Но в таком случае каждый раз требуются стяжки для пружин амортизаторов. Такое приспособление поможет быстро и качественно выполнить работу, а сделать его своими руками хоть и не так легко, но все же возможно при наличии некоторых навыков.

В этой статье речь пойдет о том, как при минимальных затратах денег, времени и сил – можно изготовить стяжки и как правильно их использовать.

Существует масса способов для изготовления такого устройства. Главная идея их состоит в том, чтобы сэкономить деньги и используя ненужные подручные материалы сделать инструмент. На любом автомобильном рынке вам удастся найти гидравлическое устройство, которое легко используется при ремонте, но стоимость его высоковата как для маленького приспособления.

Если вы покопаетесь в своем гараже, то обязательно сможете там найти ненужные на первый взгляд вещи. Проанализируйте, смогут ли они частично воссоздать ту конструкцию, которую вы видели на рынке. Гидравлические стяжки для амортизатора вряд-ли получится воссоздать, а вот заменить их механическим устройством – вполне реально.

Рассмотрим краткую инструкцию, как сделать стяжки для пружин амортизаторов своими руками.

1. Снимаем амортизатор переднего колеса и измеряем размер большой пружины, которая мешает замене. Измерение начинаем от первого большого витка и заканчиваем последним. Все данные записываем на листике бумаги, желательно в одной единице измерения (сантиметры или миллиметры), которая более вам удобна. Стяжки рекомендуется

Как сделать съемник пружин амортизаторов своими руками

Уважаемые посетители сайта «Лабуда блог» сегодня мы с вами рассмотрим один из вариантов изготовления самодельного съемника пружин амортизаторов своими руками, а так же просмотрим пошаговые фото сборки пружинного съемника и видео..

 Каждый автолюбитель кто хоть раз ремонтировал подвеску легкового автомобиля прекрасно знает, как непросто снимаются пружины амортизатора и чтобы выполнить эту операцию без специального инструмента придется изрядно изловчиться.  А вот если немного подумать и применить смекалку, то простой съемник амортизационных пружин вполне можно изготовить самостоятельно и при этом с минимальными затратами, так сказать простой и бюджетный вариант инструмента облегчающего жизнь автомобилисту.

Устройство и принцип действия представленного съемника на самом деле довольно прост и понятен, за основу взята сжимающая сила винтовой стяжки пружины, а именно на шпильке установлены 2 металлических крюка которые зацепляются за пружину и под воздействием закручивания гайки пружина сжимается, а затем извлекается с стойки.

И так, давайте рассмотрим, что конкретно понадобится для сборки съемника.

Материалы

1. металлическая труба 16-20 мм
2. шпилька М-14
3. уголок
4. гайка 2 шт
5. солидол

Инструменты

1. сварочный инвертор
2. дрель
3. тиски
4. молоток
5. гаечный ключ
6. УШМ (болгарка)

Пошаговая инструкция по созданию съемника пружин амортизатора своими руками.

 Для изготовления металлических крючьев нам понадобится водопроводная труба 16-20 мм. Распиливаем сначала вдоль делая пропил, а затем пилится необходимое число заготовок.

 Вот что получается.

 Затем заготовка зажимается в тисках и ударами молотка выпрямляется одна сторона крюка.

 Вот примерно такие крюки должны у вас получиться.

 Далее берется уголок.

Отпиливается несколько заготовок.

 Сверлим отверстие ровно по центру.

 Крюки привариваются к уголкам.

 Дополнительно для усиления конструкции было принято решение наварить отрезок трубки.

 После чего собираем съемник в единую конструкцию и приступаем к демонтажу пружины амортизатора, крючья цепляются за пружину, а далее начинаем закручивать гайку по резьбе шпильки, тем самым осаживая пружинку и извлекаем.  Для закрепления пройденного материала можете посмотреть видео. Приятного просмотра.

Источник: samodelkindrug.ru

Набор инструментов для съемника внутреннего подшипника с 3 кулачками, обслуживание тяги подшипника с внутренним отверстием Продажа

Способы доставки

Общее примерное время, необходимое для получения вашего заказа, показано ниже:

• Вы размещаете заказ
• (Время обработки)
• Отправляем Ваш заказ
• (время доставки)
• Доставка!

Общее расчетное время доставки

Общее время доставки рассчитывается с момента размещения вашего заказа до момента его доставки вам.Общее время доставки делится на время обработки и время доставки.

Время обработки: Время, необходимое для подготовки вашего товара (ов) к отправке с нашего склада. Это включает в себя подготовку ваших товаров, выполнение проверки качества и упаковку для отправки.

Время доставки: Время, в течение которого ваш товар (-ы) дойдет с нашего склада до места назначения.

Рекомендуемые способы доставки для вашей страны / региона указаны ниже:

Этот склад не может быть доставлен к вам.

Примечание:

(1) Вышеупомянутое время доставки относится к расчетному времени в рабочих днях, которое займет отгрузка после отправки заказа.

(2) Рабочие дни не включают субботу / воскресенье и праздничные дни.

(3) Эти оценки основаны на нормальных обстоятельствах и не являются гарантией сроков доставки.

(4) Мы не несем ответственности за сбои или задержки в доставке в результате любых форс-мажорных обстоятельств, таких как стихийные бедствия, плохая погода, война, таможенные проблемы и любые другие события, находящиеся вне нашего прямого контроля.

(5) Ускоренная доставка не может быть использована для почтовых ящиков

Расчетные налоги: Может взиматься налог на товары и услуги (GST).

Способы оплаты

* В настоящее время мы предлагаем оплату наложенным платежом для Саудовской Аравии, Объединенных Арабских Эмиратов, Кувейта, Омана, Бахрейна, Катара, Таиланда, Сингапура, Малайзии, Филиппин, Индонезии, Вьетнама, Индии. Мы отправим на ваш мобильный телефон код подтверждения, чтобы проверить правильность ваших контактных данных. Убедитесь, что вы следуете всем инструкциям, содержащимся в сообщении.

* Оплата в рассрочку (кредитная карта) или Boleto Bancário доступна только для заказов с адресами доставки в Бразилии.

Здоровых домашних блюд из зефира (без кукурузного сиропа)

Избегайте кукурузного сиропа и искусственных красителей, когда готовите эти полезные для здоровья пасхальные угощения домашнего зефира Peeps ® . Это веселое занятие, которое не так сложно, как вы думаете.

Приготовление зефира для меня не новость. Я уже много лет делаю домашний зефир. Я делаю это отчасти потому, что мне это нравится, а отчасти потому, что могу контролировать ингредиенты, когда делаю их сам.

Но дело не только в этом. Зефир здесь, в Испании, странный. Белые здесь найти сложно, а разноцветный зефир, который продают, слишком сладкий. Фактически, если вы попытаетесь поджарить их на огне, они просто сгорят.

С другой стороны, приготовление домашней версии забавного пасхального угощения, маршмеллоу Peeps®, было для меня в новинку. Я уже несколько лет хотел попробовать их, но по какой-то причине откладывал это до сих пор.

Домашний зефир без кукурузного сиропа

Я всегда делал зефир без кукурузного сиропа.Сначала это было не потому, что у меня была особая проблема с кукурузным сиропом. Я приготовил их без кукурузного сиропа, потому что это не то, что можно легко найти в Испании.

За годы попробовала несколько разных рецептов. Большинство использовали сироп Lyle’s Golden вместо кукурузного сиропа. Lyle’s — это обычный британский сахарный сироп, который я легко могу найти здесь, в Испании.

GAPS и палеодружественные

В то время как те, кто пытается избежать кукурузного сиропа, предпочли бы рецепт, приготовленный из Lyle’s, сахарный сироп не разрешен людям, придерживающимся GAPS или палео образ жизни.

Те, кто придерживается GAPS или палеодиеты, будут рады узнать, что зефир легко приготовить из меда.

Эти здоровые?

Давайте начнем. Хотя мед и натуральные красители делают зефир, возможно, более полезным, это ни в коем случае не является полезным рецептом. Он по-прежнему с высоким содержанием сахара. Они предназначены для использования в качестве случайного угощения при здоровом и разнообразном питании.

Приготовление зефира

Первый шаг к приготовлению угощений в стиле Peeps® — это приготовить настоящую основу из зефира.Это можно сделать с помощью сахара, сахарного сиропа или меда, как я вам сегодня покажу.

Два основных компонента домашнего зефира — это желатин и сахар. После растворения и смешивания, нагрейте до определенной точки, а затем взбивая достаточно долго, получается мягкий пушистый зефир. Это действительно потрясающе, и дети, как правило, ОБОЖАЮТ делать это.

Заставьте желатин цвести

Начните с размягчения желатина в небольшом количестве воды. Набухание желатина называется «цветением».«Я обычно использую 3 столовые ложки воды на полстакана воды на одну порцию. (Возможно использование меньшего количества желатина, и в результате зефир станет немного мягче.)

Благодаря увлажнению желатина, он легче включается и растворяется в остальных ингредиентах позже.

Нагреть медовую смесь

Пока желатин размягчается, можно нагреть мед с небольшим количеством воды. Я использую одну чашку меда на полстакана воды. Если вы используете твердый или густой мед, мед будет растворяться в воде при нагревании.

Нагрейте смесь до 240ºF / 115ºC. Хотя эта температура попадает в стадию мягкого шарика при изготовлении конфет, я считаю, что с медом ее очень трудно проверить по текстуре. Следить за показаниями температуры легче.

Документирование Spring Boot REST API с помощью Swagger и SpringFox

Как задокументировать API-интерфейсы Spring Boot REST с помощью Swagger и SpringFox?

Swagger и SpringFox

Документирование вашего REST API очень важно. Это общедоступный интерфейс, который могут использовать другие модули, приложения или разработчики. Даже если вы не разоблачаете это публично, это все равно важно. Код backend и frontend обычно разрабатывается разными разработчиками. Обычно API создает не тот, кто его использует. Поэтому крайне важно иметь должным образом документированный интерфейс, чтобы избежать путаницы и постоянно обновлять его.

Одной из самых популярных спецификаций документации API является OpenApi, ранее известная как Swagger.Он позволяет описывать свойства вашего API, используя метаданные JSON или YAML. Он также предоставляет веб-интерфейс, который может превращать метаданные в красивую HTML-документацию. Более того, из этого пользовательского интерфейса вы можете не только просматривать информацию о своей конечной точке API, но и использовать пользовательский интерфейс в качестве клиента REST — вы можете вызвать любую из своих конечных точек, указать данные для отправки и проверить ответ. Это очень удобно.

Однако нереально писать такую ​​документацию вручную и постоянно обновлять ее при каждом изменении кода.Вот где в игру вступает SpringFox. Это интеграция Swagger для Spring Framework. Он может автоматически проверять ваши классы, обнаруживать контроллеры, их методы, классы моделей, которые они используют, и URL-адреса, которым они сопоставлены. Без какой-либо рукописной документации он может генерировать много информации о вашем API, просто проверяя классы в вашем приложении. Как это круто? Самое главное, что всякий раз, когда вы вносите изменения, они будут отражены в документации.

Стартовый проект

Для начала вам понадобится приложение Spring Boot с некоторыми контроллерами Rest, я приготовил простой здесь.

Для этой статьи я использовал SpringFox 2.9.2 и Spring Boot 1.5.10.RELEASE. Он использует версию 2 спецификации Swagger. Версия 3 уже вышла, но еще (по состоянию на 2/2018) не поддерживается SpringFox. Поддержка должна быть доступна в следующей версии.

Исходный код окончательного проекта, созданного со всеми функциями, описанными в этом сообщении, доступен на GitHub.

Добавление зависимостей

Чтобы работать с SpringFox в вашем проекте, вам нужно сначала добавить его как зависимость.Если вы используете Maven, вы можете использовать следующее (вы можете проверить, доступна ли более новая версия).

  <зависимость>
     io.springfox 
     springfox-swagger2 
     2.9.2 
  

Или, если вы используете Gradle:

  скомпилировать «io.springfox: springfox-swagger2: 2.9.2»  

Базовая конфигурация

После добавления зависимости вам необходимо предоставить базовую конфигурацию Spring.Хотя технически вы можете использовать один из существующих файлов конфигурации, лучше иметь для него отдельный файл. Первое, что вам нужно будет предоставить, это аннотация @ EnableSwagger2 . Затем вам необходимо предоставить компонент Docket, который является основным компонентом, используемым для настройки SpringFox.

  @ Конфигурация
@ EnableSwagger2
public class SpringFoxConfig {
    @Bean
    public Docket apiDocket () {
        вернуть новый Docket (DocumentationType.SWAGGER_2)
                .Выбрать()
                .apis (RequestHandlerSelectors.any ())
                .paths (PathSelectors.any ())
                .build ();
    }
}  

Конечно, вы можете предоставить гораздо больше настроек конфигурации, как мы увидим позже, но это минималистичная конфигурация, которая выполняет следующие функции:

• @ EnableSwagger2 включает поддержку SpringFox для Swagger 2.
• DocumentationType.SWAGGER_2 сообщает компоненту Docket, что мы используем версию 2 спецификации Swagger.
• select () создает конструктор, который используется для определения контроллеров и их методов, которые следует включить в сгенерированную документацию.
• apis () определяет классы (классы контроллера и модели), которые необходимо включить. Здесь мы включаем их все, но вы можете ограничить их базовым пакетом, аннотациями классов и многим другим.
• paths () позволяют определить, какие методы контроллера следует включить, на основе их сопоставлений путей.Сейчас мы включаем их все, но вы можете ограничить это с помощью регулярных выражений и т. Д.

Добавление пользовательского интерфейса

Если вы развернете свое приложение сейчас, метаданные swagger, описывающие ваш API, уже будут созданы! Вы можете проверить это:

  http: // localhost: 8080 / v2 / api-docs  

Оказывается, это просто большой JSON, не очень читаемый человеком. Но вы уже можете убедиться, что это работает. Просто зайдите в онлайн-редактор Swagger и вставьте туда JSON.Вставьте сгенерированный JSON на левую панель и вуаля! Теперь вы можете видеть созданную вами документацию в виде HTML-страницы. Красиво, не правда ли? Было бы еще лучше иметь такую ​​документацию непосредственно как часть вашего приложения. К счастью, добиться этого довольно просто. Графический интерфейс, отображающий HTML-документацию на основе входных данных JSON, называется swagger-ui . Чтобы включить это приложение Spring Boot, вам просто нужно добавить эту зависимость:

 
<зависимость>
     io.springfox 
     springfox-swagger-ui 
    <версия> 2.9.2 



скомпилировать «io.springfox: springfox-swagger-ui: 2.9.2»  

Документация будет автоматически доступна здесь:

Добавление ApiInfo

По умолчанию заголовок нашей документации выглядит довольно общим:

Пора что-то с этим делать. Мы можем изменить всю информацию, просто изменив конфигурацию. В файл SpringFoxConfiguration нам нужно добавить объект ApiInfo , который предоставляет общую информацию об API, такую ​​как название, версия, контактная информация или информация о лицензии.

  @Bean
public Docket apiDocket () {
    вернуть новый Docket (DocumentationType.SWAGGER_2)
            .Выбрать()
            .apis (RequestHandlerSelectors.any ())
            .paths (PathSelectors.any ())
            .build ()
            .apiInfo (getApiInfo ());
}

private ApiInfo getApiInfo () {
    вернуть новый ApiInfo (
            "ЗАГЛАВИЕ",
            "ОПИСАНИЕ",
            "ВЕРСИЯ",
            «УСЛОВИЯ ОБСЛУЖИВАНИЯ URL»,
            новый контакт ("ИМЯ", "URL", "EMAIL"),
            "ЛИЦЕНЗИЯ",
            "URL ЛИЦЕНЗИИ",
            Коллекции.emptyList ()
    );
}  

Теперь заголовок нашей документации должен выглядеть намного лучше:

Сужение обработанных API

Пока все хорошо. Но когда вы внимательно посмотрите на сгенерированную документацию, вы увидите, что в дополнение к нашим классам Model и Controller, которые мы используем, есть также некоторые классы, специфичные для Spring, такие как BasicErrorController в разделах Controllers, а также View и ModelAndView в разделе «Модели».

Иногда полезно сузить классы, которые SpringFox определит как источники для генерации документации. Оба класса Controller и Model. Вы можете легко настроить это в конфигурации Docket. Помните, как мы использовали .apis (RequestHandlerSelectors.any () , чтобы включить все классы? Давайте сузим его до нашего базового пакета:

  @Bean
public Docket apiDocket () {
    вернуть новый Docket (DocumentationType.SWAGGER_2)
            .Выбрать()
            .apis (RequestHandlerSelectors.basePackage ("com.vojtechruzicka"))
            .paths (PathSelectors.any ())
            .build ()
            .apiInfo (getApiInfo ());
}  

Это полезно, когда вы хотите указать, какие классы должны быть включены. Иногда вам также нужно включать только определенные URL-адреса. Возможно, вы используете несколько версий своего API для обратной совместимости, но не хотите включать исторические. Возможно, какая-то часть API является внутренней и не должна быть частью общедоступной документации. В любом случае такое включение на основе сопоставления URL-адресов также можно настроить в Docket. Помните .paths (PathSelectors.any ()) ? Вместо любого, который соответствует всем путям, вы можете ограничить его только некоторым регулярным выражением или шаблонами путей в стиле Ant.

  @Bean
public Docket apiDocket () {
    вернуть новый Docket (DocumentationType.SWAGGER_2)
            .Выбрать()
            .apis (RequestHandlerSelectors.basePackage ("com.vojtechruzicka"))
            .paths (PathSelectors.ant ("/ v2 / **"))
            .build ()
            .apiInfo (getApiInfo ());
}  

Если вам недостаточно встроенных параметров, вы всегда можете указать собственный предикат для путей apis () и () . Альтернативный способ игнорировать определенные классы или методы — аннотировать их с помощью @ApiIgnore .

Использование аннотаций JSR-303

JSR 303: Bean Validation позволяет аннотировать поля ваших Java-классов для объявления ограничений и правил проверки. Вы можете аннотировать отдельные поля такими правилами, как — не может быть нулевым, минимальное значение, максимальное значение, соответствие регулярному выражению и так далее.

  public class Person {
    @Ненулевой
    частный int id;

    @NotBlank
    @ Размер (мин. = 1, макс. = 20)
    частная строка firstName;

    @NotBlank
    @Pattern (regexp = "[НЕКОТОРЫЕ ОБЫЧНОЕ ВЫРАЖЕНИЕ]")
    частная строка lastName;

    @Min (0)
    @ Макс (100)
    частный возраст;

    
}  

Это обычная практика, которая уже широко используется. Хорошей новостью является то, что SpringFox может генерировать документацию Swagger на основе таких аннотаций, поэтому вы можете использовать то, что у вас уже есть в своем проекте, без написания всех ограничений вручную! Это очень полезно, так как потребители вашего API знают, какие ограничения на значения, которые они должны предоставить вашему API, и какие значения ожидать.Без включения таких аннотаций сгенерированная документация для нашей модели человека выглядит довольно простой, ничего кроме имен полей и их типа данных.

С данными из аннотаций JSR-303 это будет выглядеть намного лучше:

К сожалению, документация на основе JSR-303 не работает из коробки, вам нужна дополнительная зависимость:

 
<зависимость>
    io.springfox 
    Springfox-bean-validators 
   <версия> 2.9.2 

 

скомпилировать «io.springfox: springfox-bean-validators: 2.9.2»  

И вам необходимо импортировать файл конфигурации BeanValidatorPluginsConfiguration поверх вашего класса конфигурации swagger:

  @ Конфигурация
@ EnableSwagger2
@Import (BeanValidatorPluginsConfiguration.class)
public class SpringFoxConfig {
  ...
}  

Добавление аннотаций Swagger Core к классам модели

Преимущество использования JSR-303 заключается в том, что, если вы уже используете их, вы получаете дополнительную документацию без усилий и без изменения кода. Проблема в том, что в настоящее время SpringFox не отображает сообщения проверки, указанные в аннотациях. Кроме того, у вас могут быть более сложные ограничения, которые вам нужно задокументировать. В таких случаях вы можете использовать аннотации Swagger Core, которые позволяют указать дополнительную информацию, например описание. Класс Person, снабженный этими аннотациями, может выглядеть примерно так.

  @ApiModel (description = "Класс, представляющий человека, отслеживаемого приложением.")
public class Person {
    @ApiModelProperty (notes = "Уникальный идентификатор человека.У двух человек не может быть одинаковых id. ", Example =" 1 ", required = true, position = 0)
    частный int id;
    @ApiModelProperty (notes = "Имя человека.", Example = "John", required = true, position = 1)
    частная строка firstName;
    @ApiModelProperty (notes = "Фамилия человека.", Example = "Doe", required = true, position = 2)
    частная строка lastName;
    @ApiModelProperty (notes = "Возраст человека.  Целое неотрицательное число", example = "42", position = 3)
    частный возраст;

    
}  

На уровне класса вы используете аннотацию @ApiModel , а на уровне поля @ApiModelProperty .Вы, конечно, можете смешивать и сочетать аннотации JSR-303. @ApiModelProperty Пример полезен для предоставления примерных значений, которые полезны не только для руководства пользователями, но также используются для предварительного заполнения полезной нагрузки запроса при использовании пользовательского интерфейса Swagger в качестве клиента REST для тестирования ваших служб. Атрибут Position удобен для указания порядка, в котором атрибуты будут отображаться в документации. Полезно сначала указать важные или обязательные атрибуты или сгруппировать принадлежащие друг другу атрибуты.В противном случае атрибуты будут перечислены в алфавитном порядке.

Добавление аннотаций Swagger Core к классам контроллера

Так же, как вы могли бы аннотировать свои классы модели с помощью основных аннотаций Swagger для предоставления дополнительных метаданных, вы можете аннотировать свои контроллеры и их методы и параметры методов.

• @Api описывает весь контроллер
• @ApiOperation используется для описания на уровне методов
• @ApiParam используется для параметров метода

  @RestController
@RequestMapping ("/ v2 / person /")
@Api (description = "Набор конечных точек для создания, получения, обновления и удаления лиц.")
public class PersonController {

    private PersonService personService;

    @RequestMapping (метод = RequestMethod.GET, производит = "application / json")
    @ApiOperation ("Возвращает список всех лиц в системе.")
    public List getAllPersons () {
        return personService.getAllPersons ();
    }

    @RequestMapping (метод = RequestMethod.GET, path = "/ {id}", производит = "application / json")
    @ApiOperation ("Возвращает конкретного человека по его идентификатору. 404, если не существует.")
    public Person getPersonById (@ApiParam ("Идентификатор человека, который нужно получить.Не может быть пустым. ")
                                    @PathVariable int id) {
        вернуть personService.getPersonById (id);
    }

    @RequestMapping (метод = RequestMethod.DELETE, path = "/ {id}")
    @ApiOperation («Удаляет человека из системы. 404, если идентификатор человека не найден.»)
    public void deletePerson (@ApiParam ("Идентификатор удаляемого человека. Не может быть пустым.")
                                 @PathVariable int id) {
        personService.deletePerson (id);
    }

    @RequestMapping (метод = RequestMethod.POST, производит = "application / json")
    @ApiOperation («Создает нового человека.»)
    public Person createPerson (@ApiParam ("Персональная информация для нового человека, который будет создан.")
                                   @RequestBody Person человек) {
        return personService.createPerson (человек);
    }

    @Autowired
    public void setPersonService (PersonService personService) {
        this.personService = personService;
    }
}  

Теперь ваша документация должна содержать также предоставленные описания:

Обратите внимание, что наши классы контроллера и домена теперь страдают от аннотаций, специфичных для Swagger. Сильно страдает удобочитаемость, поскольку важная информация теряется в большом количестве мусора. Что еще хуже — документация, написанная таким образом, не обновляется при изменении кода, вам нужно не забыть изменять сообщения вручную. Это увеличивает риск того, что ваши документы не будут синхронизированы и, следовательно, не заслуживают доверия. Хорошо включать только важную информацию, которая неочевидна и еще не покрыта автоматически сгенерированной информацией. Наличие описательных имен параметров вместе с аннотациями JSR-303 обычно позволяет документировать большую часть необходимой информации.

Загрузка описания из файлов свойств

Предоставлять описания прямо в аннотациях не очень элегантно. Это может занять много места, загрязняя ваш код. Вы не можете поддерживать несколько языков. Если вы хотите исправить опечатку или внести некоторые изменения в документацию, вам необходимо перестроить и повторно развернуть все приложение. У вас не может быть разных значений в зависимости от среды. Не очень гибкий. К счастью, Spring предоставляет концепцию заполнителей свойств.Короче говоря, он позволяет вам предоставить заполнитель $ {placeholder} вместо жестко запрограммированного значения. Затем вы определяете значение заполнителя в файле .properties. Spring загружает данные из свойств и вводит их вместо заполнителя. Что здорово, так это то, что вы можете предоставить несколько файлов свойств для каждого языка. Вы можете предоставить разные файлы свойств в разных средах. Они могут быть просто в пути к классам, поэтому вам не нужно перестраивать и повторно развертывать все приложение, просто измените файл свойств.

SpringFox поддерживает этот механизм в некоторых аннотациях. Это хороший способ отделить документацию от кода и добиться большей гибкости. К сожалению, в настоящее время поддерживается только часть аннотаций. Так, например, в модели они поддерживают его на уровне метода ( @ApiModelProperty ), но не на уровне класса ( @ApiModel ).

Для работы вам необходимо:

1. Создайте файл свойств, например чванство.недвижимость
2. Введите желаемые сообщения в виде пар «ключ-значение», где ключ будет использоваться в качестве заполнителя, например person.id = Уникальный идентификатор человека
3. Вместо текста аннотации вставьте заполнитель, например $ {person.id}
4. Зарегистрируйте файл свойств в своей конфигурации на уровне класса — например. @PropertySource («путь к классам: swagger.properties»)

Альтернативы

SpringFox и Swagger — хороший выбор.Однако перед выбором вы можете попробовать альтернативу. Есть очень интересный проект, который на самом деле является частью Spring Framework. Это называется Spring Rest Docs. Одним из его преимуществ является то, что он тесно интегрирован с вашими тестами. Это означает, что он может гарантировать, что ваша документация всегда актуальна. В противном случае ваши тесты больше не пройдут. Добавьте параметр запроса, не документируя его, и ваши тесты больше не будут зелеными. Удалите параметр, не обновляя документы, и ваши тесты не пройдут.Вы можете узнать больше в следующей статье:

Spring REST Docs — Тестовая документация вашего REST API

Заключение

SpringFox — полезный инструмент, который может автоматически генерировать документацию Swagger на основе вашего контроллера Spring и классов модели. Он также может распознавать аннотации JSR-303, поэтому вы также должны задокументировать все ограничения для классов вашей модели.Он также может использовать основные классы Swagger, такие как @ApiModelProperty. Будьте осторожны, так как это изводит ваш код множеством аннотаций, специфичных для чванства. Всегда лучше использовать их только тогда, когда SpringFox не может сам вывести информацию. Используйте их только тогда, когда вам нужно добавить описание, в котором имена классов, атрибутов и методов не говорят сами за себя.