Включение информационного объекта в конфигурацию плагина Swagger Maven - PullRequest
1 голос
/ 18 сентября 2019

У меня проблемы с включением информационного объекта в мой файл json вывода swagger.Я использую плагин swagger-maven из https://github.com/swagger-api/swagger-core. Вот что я пробовал ...

  1. Я пытался включить информационный объект в мой pom.xml, напримерэто ...

            <plugin>
            <groupId>io.swagger.core.v3</groupId>
            <artifactId>swagger-maven-plugin</artifactId>
            <version>2.0.9</version>
            <configuration>
                <outputFileName>openapi</outputFileName>
                <outputPath>${project.build.directory}/openapi-json</outputPath>
                <outputFormat>JSONANDYAML</outputFormat>
                <resourcePackages>
                    <package>org.groundlist</package>
                </resourcePackages>
                <info>
                    <version>
                        1.0
                    </version>
                    <title>
                        Swagger Pet Sample App Config File
                    </title>
                    <description>
                    This is a sample server Petstore server.  You can find out more about Swagger.                          
                    </description>
                    <termsOfService>http://swagger.io/terms/
                    </termsOfService>
                    <license>
                        <name>
                            Apache2.0
                        </name>
                        <url>
                            http://www.apache.org/licenses/LICENSE-2.0.html
                        </url>
                    </license>  
                    <contact>
                        <email>
                            gideon@dieselpoint.com
                        </email>
                    </contact>
                </info>
                <prettyPrint>TRUE</prettyPrint>
            </configuration>
            <executions>
                <execution>
                    <phase>compile</phase>
                    <goals>
                        <goal>resolve</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
    

Я также попытался добавить файл openapi-configuration.yaml в мой путь.Файл выглядит так.Я скопировал этот файл со страницы Readme репозитория плагина, поэтому его содержимое отличается от моего первого подхода, описанного выше.

    resourcePackages:
- org.groundlist
prettyPrint: true
cacheTTL: 0
openAPI:
  info:
    version: '1.0'
    title: Swagger Pet Sample App Config File
    description: 'This is a sample server Petstore server.  You can find out more
      about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net,
      #swagger](http://swagger.io/irc/).  For this sample, you can use the api key
      `special-key` to test the authorizat ion filters.'
    termsOfService: http://swagger.io/terms/
    contact:
      email: apiteam@swagger.io
    license:
      name: Apache 2.0
      url: http://www.apache.org/licenses/LICENSE-2.0.html

Ни один из этих подходов не работает.

Чего мне не хватает?Приветствия.

1 Ответ

0 голосов
/ 19 сентября 2019

Обновление Я получил это работает следующим образом ... В моем pom.xml ...

            <plugin>
            <groupId>io.swagger.core.v3</groupId>
            <artifactId>swagger-maven-plugin</artifactId>
            <version>2.0.9</version>                
            <configuration>
                <outputFileName>openapi</outputFileName>
                <outputPath>${project.build.directory}/openapi-json</outputPath>
                <outputFormat>JSONANDYAML</outputFormat>
                <resourcePackages>
                    <package>org.groundlist.core.services</package>
                </resourcePackages>
                <configurationFilePath>${project.basedir}/openapi.yaml</configurationFilePath>              
            </configuration>
            <executions>
                <execution>
                    <phase>compile</phase>
                    <goals>
                        <goal>resolve</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

А затем в отдельном файле конфигурации YAML ...

  openAPI:
  info:
    version: '1.0'
    title: Groundlist API Documentation
    description: 'This is documentation for the Groundlist API. You can find out more about Groundlist at Groundlist.org.'
    termsOfService: http://groundlist.org/terms/
    license:
      name: Apache2.0
      url: http://www.apache.org/licenses/LICENSE-2.0.html
    contact:
      email: gideon@dieselpoint.com
prettyPrint: true
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...