分享:手把手生成漂亮的静态文档说明页

点击上方 "IT牧场" ,选择 "设为星标" 技术干货每日送达!

最近经常被问 https://t.itmuch.com/doc.html 文档页是怎么制作的,考虑到步骤略复杂,写篇手记总结下吧。

TIPS

https://t.itmuch.com/doc.html 是个人在慕课网视频《  面向未来微服务:Spring Cloud Alibaba从入门到进阶 [1] 》的实战项目配套文档。

效果

分享:手把手生成漂亮的静态文档说明页

总体步骤

整合Swagger,生成Swagger描述端点  /v2/api-docs 使用  swagger2markup-maven-plugin  ,将  /v2/api-docs  生成ASCIIDOC文件; 使用  asciidoctor-maven-plugin  ,将ASCIIDOC文件转换成HTML 部署

整合Swagger

TIPS

Swagger的使用非常简单,本文不展开探讨了,各位看官自行百度一下用法吧。

常用注解:

@Api @ApiOperation @ApiModel @ApiModelProperty

1 加依赖


<!– swagger –>

<!– 之所以要排除,是因为如果不排除会报NumberFormatException的警告。–>

<!– 参考:https://github.com/springfox/springfox/issues/2265–>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.9.2</version>

<exclusions>

<exclusion>

<groupId>io.swagger</groupId>

<artifactId>swagger-annotations</artifactId>

</exclusion>

<exclusion>

<groupId>io.swagger</groupId>

<artifactId>swagger-models</artifactId>

</exclusion>

</exclusions>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>2.9.2</version>

</dependency>

<dependency>

<groupId>io.swagger</groupId>

<artifactId>swagger-annotations</artifactId>

<version>1.5.21</version>

</dependency>

<dependency>

<groupId>io.swagger</groupId>

<artifactId>swagger-models</artifactId>

<version>1.5.21</version>

</dependency>

2 配置Swagger(按照自己的需要配置,下面的配置代码仅供参考)


/**

* @author itmuch.com

*/

@Configuration

@EnableSwagger2

public class SwaggerConfiguration {

/**

* swagger 信息

*

* @return 页面信息

*/

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("ITMuch API")

.description("ITMuch API")

.termsOfServiceUrl("")

.version("1.0.0")

.contact(new Contact("", "", "")).build();

}


@Bean

public Docket customImplementation() {

return new Docket(DocumentationType.SWAGGER_2)

.select()

.apis(RequestHandlerSelectors.basePackage("com.itmuch"))

.paths(PathSelectors.any())

.build()

.apiInfo(this.apiInfo());

//.globalOperationParameters(parameters);

}

}

3 为接口Swagger注解


@RestController

@RequestMapping("/notices")

@RequiredArgsConstructor(onConstructor = @__(@Autowired))

@Api(tags = "公告相关接口", description = "公告相关接口")

public class NoticeController {

/**

* 查询最新的一条公告

*

* @return 公告列表

*/

@GetMapping("/newest")

@ApiOperation(value = "查询最新的一条公告", notes = "用于:公告")

public Notice findNewest() {

return new Notice();

}

}



@AllArgsConstructor

@NoArgsConstructor

@Builder

@Data

@ApiModel("公告")

public class Notice {

/**

* ID

*/

@ApiModelProperty("id")

private Integer id;


/**

* 公告内容

*/

@ApiModelProperty("公告内容")

private String content;

}

这样,应用启动完成后,就会有一个 /v2/api-docs 端点,描述了你的API的信息。

生成ASCIIDOC

pom.xml中添加如下内容:


<build>

<plugins>

<plugin>

<groupId>io.github.swagger2markup</groupId>

<artifactId>swagger2markup-maven-plugin</artifactId>

<version>1.3.1</version>

<configuration>

<!– api-docs访问url –>

<swaggerInput>http://localhost:8080/v2/api-docs</swaggerInput>

<!– 生成为单个文档,输出路径 –>

<outputFile>src/docs/asciidoc/generated/all</outputFile>

<config>

<!– ascii格式文档 –>

<swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>

<swagger2markup.pathsGroupedBy>TAGS</swagger2markup.pathsGroupedBy>

</config>

</configuration>

</plugin>

swagger2markup-maven-plugin 插件的作用是读取  http://localhost:8080/v2/api-docs 的信息,生成ASCIIDOC文档。当然你也可以生成其他格式,比如Markdown等等。

这款插件还有很多使用姿势,详见 https://github.com/Swagger2Markup/swagger2markup-maven-plugin [2]

生成HTML

下面,只需要将ASCIIDOC转换成html就OK了,在pom.xml中添加如下内容:


<build>

<plugins>

<plugin>

<groupId>org.asciidoctor</groupId>

<artifactId>asciidoctor-maven-plugin</artifactId>

<version>1.5.6</version>

<configuration>

<!– asciidoc文档输入路径 –>

<sourceDirectory>src/docs/asciidoc/generated</sourceDirectory>

<!– html文档输出路径 –>

<outputDirectory>src/docs/asciidoc/html</outputDirectory>

<backend>html</backend>

<sourceHighlighter>coderay</sourceHighlighter>

<!– html文档格式参数 –>

<attributes>

<doctype>book</doctype>

<toc>left</toc>

<toclevels>3</toclevels>

<numbered></numbered>

<hardbreaks></hardbreaks>

<sectlinks></sectlinks>

<sectanchors></sectanchors>

</attributes>

</configuration>

</plugin>

asciidoctor-maven-plugin 插件同样也有很多姿势,详见: https://github.com/asciidoctor/asciidoctor-maven-plugin [3]

生成的文件在 src/docs/asciidoc/html (看你插件上面的配置哈),然后你就可以弄个NGINX部署了。

干货分享

最近将个人学习笔记整理成册,使用PDF分享。关注我,回复如下代码,即可获得百度盘地址,无套路领取!

001:《Java并发高并发解决方案》学习笔记; 002:《深入JVM内核——原理、诊断与优化》学习笔记; 003:《Java面试宝典》 004:《Docker开源书》 005:《Kubernetes开源书》 006:《DDD速成(领域驱动设计速成)》 007: 全部 008: 加技术讨论群

近期热文

References

[1] 面向未来微服务:Spring Cloud Alibaba从入门到进阶:  https://coding.imooc.com/class/358.html

[2]https://github.com/Swagger2Markup/swagger2markup-maven-plugin

[3]https://github.com/asciidoctor/asciidoctor-maven-plugin

想知道更多?长按/扫码关注我吧↓↓↓ 分享:手把手生成漂亮的静态文档说明页 >>>技术讨论群<<< 喜欢就点个 "在看" 呗^_^

原文 

http://mp.weixin.qq.com/s?__biz=MzI4ODQ3NjE2OA==&mid=2247485500&idx=1&sn=60ccaff14b2243b47f63c58741f55f91

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » 分享:手把手生成漂亮的静态文档说明页

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址