资源简介

最近开发时需要用swagger生成文档,经多次测试,形成了一个完整的生成方案,供大家参考。可以在生成的文档中处定义章节。完整调试,保证可用。
工程后,操作步聚如下:
1、修改生成最终文档的索引文件index.adoc,在src/docs/asciidoc目录中,根据自己需要添加章节
2、修改pom.xml的30行地址,改为需要生成文档的系统地址
3、使用命令:mvn clean test 生成接口手册文档
4、生成的的文档路径如下:
target\asciidoc\html
target\asciidoc\pdf

资源截图

代码片段和文件信息

package io.github.robwin.swagger2markup.petstore;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter;

import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.objectMapper;
import com.fasterxml.jackson.dataformat.smile.SmileFactory;
import com.fasterxml.jackson.module.afterburner.AfterburnerModule;

/**
 * Project:   spring-swagger2markup-demo
 * @author Robert Winkler
 */
@SpringBootApplication
public class Application {

    public static void main(Stri

 属性            大小     日期    时间   名称
----------- ---------  ---------- -----  ----
     目录           0  2020-03-13 21:56  spring-swagger2markup - CSDN\
     文件          33  2018-08-14 17:01  spring-swagger2markup - CSDN\.gitignore
     文件          70  2018-08-14 17:01  spring-swagger2markup - CSDN\.travis.yml
     目录           0  2020-03-13 14:26  spring-swagger2markup - CSDN\build\
     文件        4027  2018-08-14 17:01  spring-swagger2markup - CSDN\build.gradle
     目录           0  2020-03-13 14:26  spring-swagger2markup - CSDN\build\asciidoc\
     目录           0  2020-03-13 14:26  spring-swagger2markup - CSDN\build\asciidoc\snippets\
     目录           0  2020-03-13 14:26  spring-swagger2markup - CSDN\build\asciidoc\snippets\addPetUsingPOST\
     文件         223  2020-03-13 22:04  spring-swagger2markup - CSDN\build\asciidoc\snippets\addPetUsingPOST\curl-request.adoc
     文件         245  2020-03-13 22:04  spring-swagger2markup - CSDN\build\asciidoc\snippets\addPetUsingPOST\http-request.adoc
     文件         129  2020-03-13 22:04  spring-swagger2markup - CSDN\build\asciidoc\snippets\addPetUsingPOST\http-response.adoc
     文件         217  2020-03-13 22:04  spring-swagger2markup - CSDN\build\asciidoc\snippets\addPetUsingPOST\httpie-request.adoc
     目录           0  2020-03-13 14:26  spring-swagger2markup - CSDN\gradle\
     文件        5080  2018-08-14 17:01  spring-swagger2markup - CSDN\gradlew
     文件        2314  2018-08-14 17:01  spring-swagger2markup - CSDN\gradlew.bat
     目录           0  2020-03-13 14:26  spring-swagger2markup - CSDN\gradle\wrapper\
     文件       51018  2018-08-14 17:01  spring-swagger2markup - CSDN\gradle\wrapper\gradle-wrapper.jar
     文件         231  2018-08-14 17:01  spring-swagger2markup - CSDN\gradle\wrapper\gradle-wrapper.properties
     目录           0  2020-03-13 14:26  spring-swagger2markup - CSDN\images\
     文件      119258  2018-08-14 17:01  spring-swagger2markup - CSDN\images\Demo.PNG
     目录           0  2020-03-13 21:49  spring-swagger2markup - CSDN\json\
     文件       13843  2020-03-13 21:49  spring-swagger2markup - CSDN\json\swagger.json
     文件       15570  2020-03-13 22:05  spring-swagger2markup - CSDN\pom.xml
     文件        2473  2018-08-14 17:01  spring-swagger2markup - CSDN\README.adoc
     文件          49  2018-08-14 17:01  spring-swagger2markup - CSDN\settings.gradle
     目录           0  2020-03-13 14:26  spring-swagger2markup - CSDN\src\
     目录           0  2020-03-13 14:26  spring-swagger2markup - CSDN\src\docs\
     目录           0  2020-03-13 15:42  spring-swagger2markup - CSDN\src\docs\asciidoc\
     文件         211  2020-02-13 23:01  spring-swagger2markup - CSDN\src\docs\asciidoc\index.adoc
     文件         887  2020-03-13 21:54  spring-swagger2markup - CSDN\src\docs\asciidoc\manual_content1.adoc
     文件        1457  2020-03-13 21:54  spring-swagger2markup - CSDN\src\docs\asciidoc\manual_content2.adoc
............此处省略102个文件信息

评论

共有 条评论