smart-doc接口文档

本文主要是介绍smart-doc接口文档，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

依赖：

<!--生成文档注释--><dependency><groupId>com.github.shalousun</groupId><artifactId>smart-doc</artifactId><version>1.8.1</version><scope>test</scope>
</dependency>

测试类：

 @Testpublic void testBuilderControllersApi() {ApiConfig config = new ApiConfig();config.setServerUrl("http://localhost:8080");//当把AllInOne设置为true时，Smart-doc将会把所有接口生成到一个Markdown、HHTML或者AsciiDoc中config.setAllInOne(true);//HTML5文档，建议直接放到src/main/resources/static/doc下，Smart-doc提供一个配置常量HTML_DOC_OUT_PATHconfig.setOutPath(DocGlobalConstants.HTML_DOC_OUT_PATH);// 设置接口包扫描路径过滤，如果不配置则Smart-doc默认扫描所有的接口类// 配置多个报名有英文逗号隔开config.setPackageFilters("com.example.springbootsmartdoc.controller");//设置错误错列表，遍历自己的错误码设置给Smart-doc即可List<ApiErrorCode> errorCodeList = new ArrayList<>();for (HttpCodeEnum codeEnum : HttpCodeEnum.values()) {ApiErrorCode errorCode = new ApiErrorCode();errorCode.setValue(codeEnum.getCode()).setDesc(codeEnum.getMessage());errorCodeList.add(errorCode);}//不需要显示错误码,则可以不用设置错误码。config.setErrorCodes(errorCodeList);//生成Markdown文件HtmlApiDocBuilder.buildApiDoc(config);}

这篇关于smart-doc接口文档的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---