Jak przekonwertować adnotację Java Swagger na schemat json Swagger?

Question

Jak wygenerować plik JSON z plików Java zawierających adnotacje typu Swagger, aby Swagger-UI mógł go odczytać.

Answer 1

Jak można powiedzieć „Nie chcę, aby to zrobić ręcznie”, należy użyć wtyczki Swagger Maven:

<plugin> 
    <groupId>com.github.kongchen</groupId> 
    <artifactId>swagger-maven-plugin</artifactId> 
    <version>3.1.4</version> 
    <configuration> 
     <apiSources> 
      <apiSource> 
       <springmvc>true/false</springmvc> 
       <locations> 
        <location>com.yourpackage.something</location> 
       </locations> 
       <host>yourhost.com</host> 
       <basePath>/some/path</basePath> 
       <info> 
        <title>Your Project Title</title> 
        <version>${project.version}</version> 
        <description>Some nice stuff</description> 
        <termsOfService>...</termsOfService> 
        <contact> 
         <email>someone@somewhere.com</email> 
         <name>Your Name</name> 
         <url>www.where.to.find.you</url> 
        </contact> 
       </info> 
       <swaggerDirectory>path/to/swagger/output</swaggerDirectory> 
       <outputFormats>json</outputFormats> 
      </apiSource> 
     </apiSources> 
    </configuration> 
    <executions> 
     <execution> 
      <phase>compile</phase> 
      <goals> 
       <goal>generate</goal> 
      </goals> 
     </execution> 
    </executions> 
</plugin> 

Następnie można zrobić mvn compile i wygeneruje plik swagger.json.