如何將spring-restdocs加入war文件？

Question

將生成的spring-restdoc添加到war文件中的步驟是什麼？

Answer 1

按照以下步驟，我能夠將休息文檔整合到戰爭文件中。

1. 按照在彈簧website還編寫測試用例產生的文檔說明配置您的項目生成doc文件和。一旦初始設置完成後，下一步就是將文件整合到戰爭的文件，你可以按照以下說明：

2. 創建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. 更新POM。 XML以包括ASCII文檔的插件，複製資源

      <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> 
   

   取生成的文檔並將其添加到目標/類文件夾的護理插件條目。在這種情況下，在target/classes/public/docs下。

   1. 最後，當您部署war文件時，文檔可在http：// docs/ 下獲得。在我的情況下，我創建了index.adoc文件並生成索引。 html作爲最終輸出。