Wie werden Spring-Restdocs in die Kriegsdatei aufgenommen?

Question

Was sind die Schritte, um die generierten Spring-Restdocs in eine War-Datei aufzunehmen?

Answer 1

Mit den folgenden Schritten konnte ich Restdokumente in die WAR-Datei integrieren.

1. Folgen Sie den Anweisungen auf dem Feder website Ihr Projekt zu konfigurieren, die doc-Datei und auch das Schreiben von Testfällen zu erzeugen, die Dokumentation zu erzeugen. Nachdem die Ersteinrichtung abgeschlossen ist, ist der nächste Schritt in der Dokumentation in den Krieg-Datei zu integrieren, für die Sie die nachstehenden Anweisungen folgen:

2. erstellen SpringMvcConfiguration

   @EnableWebMvc 
   
       public class SpringMvcConfiguration extends WebMvcConfigurerAdapter { 
   
       private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { 
        "classpath:/resources/" }; 
       @Override 
       public void addResourceHandlers(ResourceHandlerRegistry registry) { 
   
       if (!registry.hasMappingForPattern("/**")) { 
        registry.addResourceHandler("/**").addResourceLocations(
          CLASSPATH_RESOURCE_LOCATIONS); 
       } 
        } 
       } 
   

3. Update der pom. xml enthält die Plug-in für ascii doc, copy-Ressourcen

      <build> 
          ..... 
           <plugins> 
            <plugin> 
            <groupId>org.asciidoctor</groupId> 
            <artifactId>asciidoctor-maven-plugin</artifactId> 
            <version>1.5.2</version> 
            <executions> 
             <execution> 
              <id>generate-docs</id> 
              <phase>prepare-package</phase> 
              <goals> 
               <goal>process-asciidoc</goal> 
              </goals> 
              <configuration> 
               <backend>html</backend> 
               <doctype>book</doctype> 
               <sourceDirectory>src/main/asciidoc</sourceDirectory> 
               <attributes> 
                <snippets>${snippetsDirectory}</snippets> 
               </attributes> 
              </configuration> 
             </execution> 
            </executions> 
           </plugin> 
           <plugin> 
            <artifactId>maven-resources-plugin</artifactId> 
            <version>2.7</version> 
            <executions> 
             <execution> 
              <id>copy-resources</id> 
              <phase>prepare-package</phase> 
              <goals> 
               <goal>copy-resources</goal> 
              </goals> 
              <configuration> 
               <outputDirectory> 
                ${project.build.outputDirectory}/public/docs 
               </outputDirectory> 
               <resources> 
                <resource> 
                 <directory> 
                  ${project.build.directory}/generated-docs 
                 </directory> 
                </resource> 
               </resources> 
              </configuration> 
             </execution> 
            </executions> 
           </plugin> 
          </plugins> 
         </build> 
   

   die Plugin-Einträge übernimmt die Dokumentation zu erzeugen und Zugabe zu den Ziel/Klassen-Ordner. In diesem Fall unter target/classes/public/docs.

   4. Schließlich, wenn Sie die WAR-Datei bereitstellen die Dokumentation unter http verfügbar: //: // docs/ In meinem Fall habe ich die index.adoc Datei erstellt und es erzeugt Index. html als endgültige Ausgabe.