Блог

Я новичок в мире Swagger, пытаюсь реализовать его для своего собственного приложения. Моя проблема в том, что SwaggerUI не принимает мой файл swagger.yml, а переносит его в контроллер. На самом деле, у меня проблемы с аутентификацией.

Swagger.yml

 swagger: "2.0"
info:
  version: "1.1"
  title:  ABC Operations
  termsOfService: http://swagger.io/terms/
host: <HOST>
basePath: /abc/operations
tags:
- name: Stored Message
  description: Stored Message Operations
schemes:
- http
- https
security:
  - basic_auth: []
paths:
  /stored-message/{transactionId}:
    get:
      tags:
      - Stored Message
      summary: Stored Message Retrieval by TransactionId
      produces:
      - application/json
      parameters:
      - in: path
        name: transactionId
        required: true
        type: string
           
      responses:
        200:
          description: OK
          schema:
            type: object
        404:
          description: Not Found
        500:
          description: Internal Server Error

    put:
      tags:
      - Stored Message
      summary: Stored Message Update
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: transactionId
        required: true
        type: string
      - in: body
        name: Modified Stored Message
        schema:
         type: object
      responses:
        200:
          description: OK
        404:
          description: Not Found
        500:
          description: Internal Server Error
  
securityDefinitions:
  basic_auth:
    type: basic
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
  

Фактически, в части SwaggerUI новое поле по умолчанию не заполняется.
Как я могу заставить пользовательский интерфейс swagger извлекать данные из swagger.yml?

В вашем файле «application.property» вы должны добавить эту строку

 springdoc.swagger-ui.url: /yourfilename.yml
  

и укажите файл yml, который вы хотите использовать для запуска SwaggerUI.

Для просмотра файл должен находиться внутри src-> resource-> static. Я рекомендую вам ознакомиться с официальной документацией на веб-сайте Springdoc https://springdoc.org/faq.html .

Добрый день