缺点:每个服务各自指定smart-doc的配置文件smart-doc.json 姿势二 导入相关smart-doc依赖 代码语言:javascript 代码运行次数:0 复制 Cloud Studio代码运行 com.github.shalousun smart-doc2.5.1 手动为每个项目引入以上jar包,可以使用smart-doc.json配置文件也可以使用smart-doc自带的ApiConfig配置类进行手动配置。 使...
配置"allInOne": true后,生成的文档中只会包含一个index.html文件。如果设置为false,生成的接口文档会包括api.html、dict.html和error.html多个文件,大家可以自行测试。 5. 接口文档界面效果 最后我们双击index.html,就可以查看生成的接口文档效果了。 大家可以根据上文的smart-doc配置,找找每个配置在接口文档中对应...
IDEA,配置文件中参考项目代码以及项目信息更新smart-doc.json配置文件,可采用下列模板 {"serverUrl":"http://127.0.0.1:port/gateway",# 服务请求路径"isStrict":false,"allInOne":true,"outPath":"src/main/resources/static/doc",# 接口文档的输出目录"coverOld":true,"createDebugPage":true,"style":"xt25...
3.2 添加smart-doc配置文件 在上面的configFile属性中的路径创建配置文件,输入以下内容: { "serverUrl": "http://127.0.0.1", //服务器地址,非必须。导出postman建议设置成http://{{server}}方便直接在postman直接设置环境变量 "pathPrefix": "", //设置path前缀,非必须。如配置Servlet ContextPath 。@since ...
2、添加smart-doc生成文档的配置 {"serverUrl": "http://127.0.0.1",//设置服务器地址,非必须"isStrict":false,//是否开启严格模式"allInOne":true,//是否将文档合并到一个文件中,一般推荐为true"outPath": "D://md2",//指定文档的输出路径"coverOld":true,//是否覆盖旧的文件,主要用于mardown文件覆盖...
配置Smart-Doc 生成 WebSocket 接口文档 准备环境 确保您的开发环境中已经安装了以下组件: Java 17 或更高版本 Maven 或 Gradle 作为构建工具 Smart-Doc 最新版插件 WebSocket 服务器实现库,如 jakarta.websocket 创建WebSocket 服务端 添加插件依赖 在pom.xml文件中添加 Smart-Doc 依赖: ...
debug接口调试html5页面完全支持文件上传,下载(@download tag标记下载方法)测试。 实现案例 从smart-doc 1.7.9开始官方提供了Maven插件,可以通过在项目中集成smart-doc的Maven插件,然后运行插件直接生成文档。 我们的案例基于smart-doc-maven-plugin,生成文档。示例参考官方配置文档而写。
2、新建接口文档配置文件 smart-doc.json {"serverUrl":"http://127.0.0.1:8091","isStrict":false,"allInOne":true,"createDebugPage":true,"style":"xt256","allInOneDocFileName":"index.html","outPath":"src/main/resources/static/doc","packageFilters":"org.example.controller.*","style":"mono...
默认我们是配置smart-doc.json的一个配置文件,里面必填参数就是“outPath”, 代码语言:javascript 代码运行次数:0 复制Cloud Studio 代码运行 { "outPath": "这里可以写resources下面的路径,在SpringBoot启动后就可以进行访问", "allInOne": true } 路径配置好像不支持相对路径,所以使用绝对路径,但还有一个方法,就...
确认项目根目录下存在有效的pom.xml文件: 确保你的项目根目录下存在pom.xml文件,这是Maven项目的核心配置文件。 在pom.xml中添加Smart-Doc相关依赖和插件配置: 你需要在pom.xml中添加smart-doc-maven-plugin插件的配置,以便在打包时生成Smart-Doc文档。以下是一个示例配置: xml <build> <plugins>...