接口文档之 springboot 集成 swagger 和 swagger-bootstrap-ui，感觉还不错

总结：其实我是讨厌写文档的，但是又不得不写文档，写接口文档的工具 有很多，如： CrapApi ，APIJSON，superapi，java-api-doc ,sosoapi,yapi 等

        这里随便写下一下 swagger 

        常用注解 如下：

 @Api：用在类上，说明该类的作用。

 @ApiOperation：注解来给API增加方法说明。

 @ApiImplicitParams : 用在方法上包含一组参数说明。

 @ApiImplicitParam：用来注解来给方法入参增加说明。

 @ApiResponses：用于表示一组响应

 @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

  *  code：数字，例如400

  *  message：信息，例如"请求参数没填好"

  *  response：抛出异常的类

 @ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

  *  @ApiModelProperty：描述一个model的属性

注意：@ApiImplicitParam的参数说明：

   paramType：指定参数放在哪个地方
    header：请求参数放置于Request Header，使用@RequestHeader获取

    query：请求参数放置于请求地址，使用@RequestParam获取

    path：（用于restful接口）-->请求参数的获取：@PathVariable

   body：（不常用）

   form（不常用）

   name：参数名
   dataType：参数类型
   required：参数是否必须传   true | false
   value：说明参数的意思
   defaultValue：参数的默认值

整合 步骤：
1.引入jar

<!-- swagger用于定义API文档 -->
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/com.spring4all/swagger-spring-boot-starter -->
<!--<dependency>
   <groupId>com.spring4all</groupId>
   <artifactId>swagger-spring-boot-starter</artifactId>
   <version>1.8.0.RELEASE</version>
</dependency>-->

<!--美化swagger-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.3</version>
</dependency>

2.配置

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.web"))
                //.paths(AppUtility.isProd() ? PathSelectors.none() : PathSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("测试swagger")
                .description("展示swagger界面")
                .termsOfServiceUrl("http://localhost:8089/swagger-ui.html")
                .contact(new Contact("lyc88", "http://localhost:8089/swagger-ui.html", "984006207@qq.com"))
                .version("1.0")
                .build();
    }
}

排除静态文件

registry.addResourceHandler("swagger-ui.html")
        .addResourceLocations("classpath:/META-INF/resources/");

registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");

registry.addResourceHandler("/webjars/**")
        .addResourceLocations("classpath:/META-INF/resources/webjars/");

 3.就可以快乐的看文档了 
http://127.0.0.1:8089/doc.html

随便写了几个例子如下：

转载于:https://www.cnblogs.com/lyc88/articles/11017540.html