Swagger2 Api文档生成工具笔记

Swagger2提供在线的html文档ui测试，如果想生成markdown文档或者alidoc格式文档需要依赖于第三方插件来做

https://github.com/Swagger2Markup/swagger2markup

第三方api文档生成工具

https://github.com/Swagger2Markup/spring-swagger2markup-demo

D:/gems/addressable-2.3.8/data/unicode.data 在跑官方DEMO的时候如果报这个错误（issues上说mac下正常）在pom加上org.jruby 依赖

<dependencies>
    <dependency>
        <groupId>org.asciidoctor</groupId>
        <artifactId>asciidoctorj-pdf</artifactId>
        <version>1.5.0-alpha.10.1</version>
    </dependency>
    <dependency>
        <groupId>org.jruby</groupId>
        <artifactId>jruby-complete</artifactId>
        <version>1.7.21</version>
    </dependency>
</dependencies>

demo

需要注意：整合项目时，API接口编写需要根据官方提供的规范编写，不然会空指针异常，比如

@RequestMapping(value = "/object", method = POST)
@ApiOperation(value = "请输入一个实体类对应的参数", response = User.class)//必须要respone
@ApiResponses({@ApiResponse(code = 400, message = "Invalid Order")})
public ResponseEntity<String> placeOrder(
         @ApiParam(value = "传入一个实体类", required = true) User user) {

     return ok("");
}

如上是一个demo，但是在Controller只有一个时依然报空指针，需要加上两个DEMO或者想官方demo那样加更多Controller接口。因为还未详细查看api文档，所有后续需要进一步研究