Привет, коллеги-разработчики! Сегодня мы собираемся погрузиться в мир Swagger и узнать, как оживить документацию по API, изменив имя по умолчанию в пользовательском интерфейсе Swagger. Swagger UI — это мощный инструмент, позволяющий создавать интерактивную и удобную для пользователя документацию для ваших API на основе спецификации OpenAPI. По умолчанию пользовательский интерфейс Swagger отображает имя вашего API как «Пользовательский интерфейс Swagger», но мы хотим персонализировать его, чтобы сделать его по-настоящему нашим. Итак, начнём!

<title>Swagger UI</title>

Просто замените «Swagger UI» на желаемое имя, например:

<title>My Awesome API Documentation</title>

Сохраните файл, обновите страницу пользовательского интерфейса Swagger и вуаля! В пользовательском интерфейсе Swagger теперь гордо отображается ваше собственное имя.

swagger:
  title: My Awesome API Documentation

Сохраните файл с соответствующим именем, например swagger-config.yamlили swagger-config.json. Затем при запуске пользовательского интерфейса Swagger передайте путь к файлу конфигурации в качестве аргумента командной строки или включите его в код инициализации пользовательского интерфейса Swagger. В вашем пользовательском интерфейсе Swagger теперь будет отображаться новое имя, указанное в файле конфигурации.

Метод 3: изменение спецификации OpenAPI
Если вы хотите изменить имя по умолчанию непосредственно в спецификации OpenAPI, вы тоже можете это сделать. Откройте файл спецификации OpenAPI вашего API (обычно файл YAML или JSON) в текстовом редакторе. Найдите раздел info, в котором содержится информация о вашем API. Найдите поле titleи измените его на желаемое имя:

info:
  title: My Awesome API Documentation

Сохраните файл, и при создании или перезагрузке пользовательского интерфейса Swagger он будет отражать обновленное имя из спецификации OpenAPI.

Метод 4. Использование аннотаций Swagger (для реализаций API)
Если вы используете аннотации Swagger в своей реализации API, вы можете изменить имя по умолчанию, указав аннотацию @Apiс желаемым значением. имя. Например, в Java с инфраструктурой Spring вы можете сделать:

@Api(value = "My Awesome API Documentation")
@RestController
public class MyApiController {
    // API methods...
}

Таким образом, пользовательский интерфейс Swagger будет отображать пользовательское имя, указанное в аннотации @Api.

Вот и все! Вы узнали несколько способов изменить имя по умолчанию в пользовательском интерфейсе Swagger. Не стесняйтесь комбинировать эти методы в зависимости от требований вашего проекта. Теперь сделайте вашу документацию API персонализированной!