You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

已完成克隆与asciidoctor构建,如何本地运行Spring REST Docs?

本地运行Spring REST Docs项目的步骤

首先明确:Spring REST Docs本身是用于生成API文档的工具库,并非可直接启动的Web应用。你克隆的仓库包含库源码及示例项目,可通过运行示例来验证功能:

1. 启动示例模块

仓库内的示例项目集中在spring-restdocs-samples目录下,可通过Gradle命令启动具体示例:

  • 若在仓库根目录,直接执行指定示例的启动命令,比如运行WebMVC示例:
    ./gradlew :spring-restdocs-samples:spring-restdocs-sample-webmvc:bootRun
    
  • 也可先进入示例目录再执行命令:
    cd spring-restdocs-samples
    ../gradlew :spring-restdocs-sample-webmvc:bootRun
    

2. 验证运行状态

示例启动后,默认使用8080端口,可通过访问对应API端点验证,比如访问http://localhost:8080(具体路径可查看示例项目源码)。

3. 查看已生成的文档

你之前执行的./gradlew asciidoctor命令已生成API文档,文档存放在对应模块的build/asciidoc/html5目录下,比如WebMVC示例的文档路径为:
spring-restdocs-samples/spring-restdocs-sample-webmvc/build/asciidoc/html5/index.html
直接用浏览器打开该HTML文件即可查看生成的API文档。

内容的提问来源于stack exchange,提问作者Peter Penzov

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.09 03:14:55