背景

• 服務(wù)端開發(fā)同學(xué)需要花很多時間編寫和維護(hù)大量的Rest接口文檔两蟀，且往往接口修改后沒有及時同步文檔，讓對接方和后續(xù)維護(hù)者一頭霧水碧注。
• 有沒有一種方式可以相對容易地生成可讀性好的Rest文檔嚣伐，并且做到與代碼同步？

目標(biāo)

• 通過Swagger注釋自動生成Rest文檔接口萍丐。
• 通過Swagger2Markup生成靜態(tài)文檔（html/markdown/wiki）

使用Swagger注解自動生成Rest文檔接口

maven引入Swagger依賴

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>

配置Swagger

@SpringBootApplication
@EnableSwagger2
public class AppStarter extends WebMvcConfigurerAdapter {
 
    public static void main(String[] args) {
        SpringApplication.run(AppStarter.class, args);
    }
 
    /**
     * 創(chuàng)建Rest Api描述
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()                       //按條件指定生成文檔接口
                .paths(PathSelectors.any())
                .build();
    }
 
    /**
     * 接口描述
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("測試項目")
                .description("User實體CRUD")
                .version("1.0")
                .build();
    }
}

• EnableSwagger2啟動Swagger
• 創(chuàng)建Docket

使用Swagger注解

controller注解

@RestController
@RequestMapping("/v1/users")
@Api(description = "用戶管理接口")
public class UserController {
 
    @PostMapping
    @ApiOperation("創(chuàng)建用戶")
    public void addUser(@RequestBody User user){
 
    }
 
    @GetMapping
    @ApiOperation("查詢用戶")
    public List<User> getUsers(@ApiParam(value = "模糊查詢用戶名") String name){
        return Lists.newArrayList(
                User.builder().id(1).name("test-name1").birth(new Date()).build(),
                User.builder().id(2).name("test-name2").birth(new Date()).build()
        );
    }
 
    @GetMapping("/{id}")
    @ApiOperation("獲取用戶")
    public User getUser(@ApiParam(value = "用戶ID") @PathVariable long id){
        return User.builder().id(id).name("test-name").birth(new Date()).build();
    }
 
    @PutMapping("/{id}")
    @ApiOperation("修改用戶")
    public void updateUser(@ApiParam(value = "用戶ID") @PathVariable long id,
                           @RequestBody User user){
    }
 
    @DeleteMapping("/{id}")
    @ApiOperation("刪除用戶")
    public void deleteUser(@ApiParam(value = "用戶ID") @PathVariable long id){
    }
}

實體注解

@ApiModel("用戶")
public class User {
 
    @ApiModelProperty("用戶ID")
    private long id;
 
    @ApiModelProperty("用戶名")
    private String name;
 
    @ApiModelProperty("生日")
    private Date birth;
}

生成api-docs

• 打好注解后轩端，編譯，啟動項目逝变。
• swagger會在springmvc中創(chuàng)建 GET http://host:port/v2/api-docs 接口基茵，輸出json格式的rest api文檔

使用Swagger2Markup生成靜態(tài)文檔

• 有了swagger的文檔api，需要將其生成可讀的文本文檔（html/markdown/wiki）壳影，并靜態(tài)化拱层。

啟動項目

• 將寫好注解的項目啟動，并保證/v2/api-docs接口可以訪問宴咧。

配置swagger2markup插件

• maven.build.plugins增加swagger2markup插件

<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>
        <!-- 生成為多個文檔，輸出路徑 -->
        <!--<outputDir>src/docs/asciidoc/generated</outputDir>-->
        <config>
            <!-- wiki格式文檔 -->
            <swagger2markup.markupLanguage>CONFLUENCE_MARKUP</swagger2markup.markupLanguage>
 
            <!-- ascii格式文檔 -->
            <!--<swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>-->
 
            <!-- markdown格式文檔 -->
            <!--<swagger2markup.markupLanguage>MARKDOWN</swagger2markup.markupLanguage>-->
            <swagger2markup.pathsGroupedBy>TAGS</swagger2markup.pathsGroupedBy>
        </config>
    </configuration>
</plugin>

運行swagger2markup插件

image.png

• mvn命令運行swagger2markup:convertSwagger2markup
• 在項目的/src/docs/asciidoc/generated中找到結(jié)果文件

處理結(jié)果文件

CONFLUENCE_MARKUP（wiki）

• confluence的wiki支持此格式

• 使用插入”wiki標(biāo)記“

  
  
  image.png

• 選擇“企業(yè)維基”掺栅，將內(nèi)容復(fù)制進(jìn)去

  
  
  image.png

MARKDOWN

• 可用在任何支持markdown的編輯器中

ASCIIDOC（html）

• ascii文檔烙肺，可以再進(jìn)一步將其轉(zhuǎn)換為可讀性優(yōu)秀的html文檔

配置asciidoctor插件

• maven.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文檔格式參數(shù) -->
        <attributes>
            <doctype>book</doctype>
            <toc>left</toc>
            <toclevels>3</toclevels>
            <numbered></numbered>
            <hardbreaks></hardbreaks>
            <sectlinks></sectlinks>
            <sectanchors></sectanchors>
        </attributes>
    </configuration>
</plugin>

運行asciidoctor插件

image.png

參考資料

• swagger-api
• swagger2markup
• http://blog.didispace.com/springbootswagger2/
• http://blog.didispace.com/swagger2markup-asciidoc/