欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

詳解如何用spring Restdocs創(chuàng)建API文檔

 更新時(shí)間:2017年05月11日 11:07:47   作者:方志朋  
這篇文章將帶你了解如何用spring官方推薦的restdoc去生成api文檔。具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下

這篇文章將帶你了解如何用spring官方推薦的restdoc去生成api文檔。本文創(chuàng)建一個(gè)簡(jiǎn)單的springboot工程,將http接口通過(guò)Api文檔暴露出來(lái)。只需要通過(guò) JUnit單元測(cè)試和Spring的MockMVC就可以生成文檔。

準(zhǔn)備工作

  1. 你需要15min
  2. Jdk 1.8
  3. maven 3.0+
  4. idea

創(chuàng)建工程

引入依賴,其pom文件:

<dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>

    <dependency>
      <groupId>org.springframework.restdocs</groupId>
      <artifactId>spring-restdocs-mockmvc</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

通過(guò)@SpringBootApplication,開(kāi)啟springboot

@SpringBootApplication
public class Application {

  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }
}

在springboot通常創(chuàng)建一個(gè)controller:

@RestController
public class HomeController {

  @GetMapping("/")
  public Map<String, Object> greeting() {
    return Collections.singletonMap("message", "Hello World");
  }

}

啟動(dòng)工程,訪問(wèn)localhost:8080,瀏覽器顯示:

{“message”:”Hello World”}

證明接口已經(jīng)寫好了,但是如何通過(guò)restdoc生存api文檔呢

Restdoc,通過(guò)單元測(cè)試生成api文檔

restdocs是通過(guò)單元測(cè)試生存snippets文件,然后snippets根據(jù)插件生成htm文檔的。

建一個(gè)單元測(cè)試類:

@RunWith(SpringRunner.class)
@WebMvcTest(HomeController.class)
@AutoConfigureRestDocs(outputDir = "target/snippets")
public class WebLayerTest {

  @Autowired
  private MockMvc mockMvc;

  @Test
  public void shouldReturnDefaultMessage() throws Exception {
    this.mockMvc.perform(get("/")).andDo(print()).andExpect(status().isOk())
        .andExpect(content().string(containsString("Hello World")))
        .andDo(document("home"));
  }
}

其中,@ AutoConfigureRestDocs注解開(kāi)啟了生成snippets文件,并指定了存放位置。

啟動(dòng)單元測(cè)試,測(cè)試通過(guò),你會(huì)發(fā)現(xiàn)在target文件下生成了一個(gè)snippets文件夾,其目錄結(jié)構(gòu)如下:

└── target
  └── snippets
    └── home
      └── httpie-request.adoc
      └── curl-request.adoc
      └── http-request.adoc
      └── http-response.adoc

默認(rèn)情況下,snippets是Asciidoctor格式的文件,包括request和reponse,另外其他兩種httpie和curl兩種流行的命令行的http請(qǐng)求模式。

到目前為止,只生成了Snippets文件,需要用Snippets文件生成文檔。

怎么用Snippets

創(chuàng)建一個(gè)新文件src/main/asciidoc/index.adoc :

用 Spring REST Docs 構(gòu)建文檔

This is an example output for a service running at http://localhost:8080:

.request
include::{snippets}/home/http-request.adoc[]

.response
include::{snippets}/home/http-response.adoc[]

這個(gè)例子非常簡(jiǎn)單,通過(guò)單元測(cè)試和一些簡(jiǎn)單的配置就能夠得到api文檔了。

adoc的書寫格式,參考:http://docs.spring.io/spring-restdocs/docs/current/reference/html5/,這里不多講解。

需要使用asciidoctor-maven-plugin插件,在其pom文件加上:

<plugin>
  <groupId>org.asciidoctor</groupId>
  <artifactId>asciidoctor-maven-plugin</artifactId>
  <executions>
    <execution>
      <id>generate-docs</id>
      <phase>prepare-package</phase>
      <goals>
        <goal>process-asciidoc</goal>
      </goals>
      <configuration>
        <sourceDocumentName>index.adoc</sourceDocumentName>
        <backend>html</backend>
        <attributes>
          <snippets>${project.build.directory}/snippets</snippets>
        </attributes>
      </configuration>
    </execution>
  </executions>
</plugin>

這時(shí)只需要通過(guò)mvnw package命令就可以生成文檔了。

在/target/generated-docs下有個(gè)index.html,打開(kāi)這個(gè)html,顯示如下,界面還算簡(jiǎn)潔:

結(jié)語(yǔ)

通過(guò)單元測(cè)試,生存adoc文件,再用adoc文件生存html,只需要簡(jiǎn)單的幾步就可以生成一個(gè)api文檔的html文件,這個(gè)html文件你可以通網(wǎng)站發(fā)布出去。整個(gè)過(guò)程很簡(jiǎn)單,對(duì)代碼無(wú)任何影響。

源碼下載:https://github.com/forezp/SpringBootLearning

以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。

相關(guān)文章

  • Java png圖片修改像素rgba值的操作

    Java png圖片修改像素rgba值的操作

    這篇文章主要介紹了Java png圖片修改像素rgba值的操作,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2021-11-11
  • 詳細(xì)介紹使用Java調(diào)用Python的四種方法

    詳細(xì)介紹使用Java調(diào)用Python的四種方法

    這篇文章主要給大家介紹了關(guān)于使用Java調(diào)用Python的四種方法,每種方法根據(jù)實(shí)際項(xiàng)目需求有其適用場(chǎng)景,其中,推薦使用Runtime.getRuntime()方法,因?yàn)樗鼮楹?jiǎn)潔且易于實(shí)現(xiàn),需要的朋友可以參考下
    2024-10-10
  • spring?boot?動(dòng)態(tài)生成接口實(shí)現(xiàn)類的場(chǎng)景分析

    spring?boot?動(dòng)態(tài)生成接口實(shí)現(xiàn)類的場(chǎng)景分析

    本文不具體介紹動(dòng)態(tài)代理,主要看一下它在springboot項(xiàng)目中的實(shí)際應(yīng)用,下面我們模仿feign來(lái)實(shí)現(xiàn)一個(gè)調(diào)用三方接口的?httpclient,感謝的朋友跟隨小編一起看看吧
    2021-11-11
  • Eclipse?IDE中如何設(shè)置JVM啟動(dòng)參數(shù)

    Eclipse?IDE中如何設(shè)置JVM啟動(dòng)參數(shù)

    這篇文章主要介紹了Eclipse?IDE中如何設(shè)置JVM啟動(dòng)參數(shù),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2022-06-06
  • Java服務(wù)中的大文件上傳和下載優(yōu)化技巧分享

    Java服務(wù)中的大文件上傳和下載優(yōu)化技巧分享

    在Java服務(wù)中處理大文件的上傳和下載是一項(xiàng)常見(jiàn)但復(fù)雜的任務(wù),為了提供優(yōu)秀的用戶體驗(yàn)和高效的系統(tǒng)性能,我們將探索多種策略和技術(shù),并在每一點(diǎn)上都提供代碼示例以便實(shí)戰(zhàn)應(yīng)用,需要的朋友可以參考下
    2023-10-10
  • Java通過(guò)HttpClient進(jìn)行HTTP請(qǐng)求的代碼詳解

    Java通過(guò)HttpClient進(jìn)行HTTP請(qǐng)求的代碼詳解

    Apache?HttpClient是一個(gè)功能強(qiáng)大且廣泛使用的Java庫(kù),它提供了方便的方法來(lái)執(zhí)行HTTP請(qǐng)求并處理響應(yīng)。本文將介紹如何使用HttpClient庫(kù)進(jìn)行HTTP請(qǐng)求,包括GET請(qǐng)求、POST請(qǐng)求、添加參數(shù)和請(qǐng)求體、設(shè)置請(qǐng)求頭等操作,需要的朋友可以參考下
    2023-05-05
  • springboot中@Async默認(rèn)線程池導(dǎo)致OOM問(wèn)題

    springboot中@Async默認(rèn)線程池導(dǎo)致OOM問(wèn)題

    這篇文章主要介紹了springboot中@Async默認(rèn)線程池導(dǎo)致OOM問(wèn)題,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2020-06-06
  • springboot+redis過(guò)期事件監(jiān)聽(tīng)實(shí)現(xiàn)過(guò)程解析

    springboot+redis過(guò)期事件監(jiān)聽(tīng)實(shí)現(xiàn)過(guò)程解析

    這篇文章主要介紹了springboot+redis過(guò)期事件監(jiān)聽(tīng)實(shí)現(xiàn)過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-03-03
  • Java結(jié)合百度云存儲(chǔ)BCS代碼分享

    Java結(jié)合百度云存儲(chǔ)BCS代碼分享

    最近云是一個(gè)很熱門的新概念,仿佛任何東西只要跟云相關(guān)聯(lián),就立馬高大上起來(lái),額,我們也追隨潮流吧,項(xiàng)目中也結(jié)合一下云?。?/div> 2014-10-10
  • Android應(yīng)用開(kāi)發(fā)的一般文件組織結(jié)構(gòu)講解

    Android應(yīng)用開(kāi)發(fā)的一般文件組織結(jié)構(gòu)講解

    這篇文章主要介紹了Android應(yīng)用開(kāi)發(fā)的一般文件組織結(jié)構(gòu)講解,同時(shí)附帶介紹了一個(gè)獲取Android的文件列表的方法,需要的朋友可以參考下
    2015-12-12

最新評(píng)論