# swagger-bootstrap-ui

**Repository Path**: cliveli/swagger-bootstrap-ui

## Basic Information

- **Project Name**: swagger-bootstrap-ui
- **Description**: swagger-bootstrap-ui 是一个基于swagger的前端UI实现,是为了替换了默认的swagger-ui,让生成的文档更加友好和美观  在原作者xiaoym的基础上进行了改进，主要是菜单项的显示，接口请求参数对象显示，在线调试模块请求参数json显示
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2017-12-11
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swagger-bootstrap-ui

------

swagger-bootstrap-ui 是一个基于swagger的前端UI实现,是为了替换了默认的swagger-ui,让生成的文档更加友好和美观

在原作者xiaoym的基础上进行了改进，主要是菜单项的显示，接口请求参数对象显示，在线调试模块请求参数json显示

### 效果
* 接口文档信息界面

![Alt text](https://gitee.com/cliveli/swagger-bootstrap-ui/raw/master/src/main/resources/examples/api-info.png)

![Alt text](https://gitee.com/cliveli/swagger-bootstrap-ui/raw/master/src/main/resources/examples/api-info-detail.png)

* 接口文档调试界面

![Alt text](https://gitee.com/cliveli/swagger-bootstrap-ui/raw/master/src/main/resources/examples/api-debug.png)

------

### 如何使用
##### 1、引入jar包

首先需要在你的 `pom.xml` 中引入`swagger` 和 `swagger-bootstrap-ui` 的包
```xml
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>
<dependency>
  <groupId>com.github.cliveli</groupId>
  <artifactId>swagger-bootstrap-ui</artifactId>
  <version>1.6</version>
</dependency>
```

##### 2、添加swagger功能
启用swagger ,创建Swagger2文件，内容如下，
> 需要注意的一点是 swagger api 的默认地址是`/v2/api-docs` 所以swagger-bootstrap-ui也读取的是默认地址，
所以在new Docket()的时候不能指定group参数，否则 swagger api 的地址会在后面加入group的参数导致swagger-bootstrap-ui不能正确请求到数据
```java

@Configuration
@EnableSwagger2
public class Swagger2
{
    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.**.**.controller"))  //服务的包名
            .paths(PathSelectors.any())
            .build();
    }
    
    private ApiInfo apiInfo()
    {
        return new ApiInfoBuilder().title("PaaS平台微服务RESTful APIs")
            .description("PaaS平台微服务RESTful APIs")
            .termsOfServiceUrl("http://{ip}:{port}/basedataApi/")  //服务访问的URL
            .version("1.0")
            .build();
    }
}
```

##### 3、生成的接口文档访问地址:
`swagger-bootstrap-ui` 的默认访问地址是 `http://${host}:${port}/doc.html`