# swagger-showdoc

**Repository Path**: stanChen/swagger-showdoc

## Basic Information

- **Project Name**: swagger-showdoc
- **Description**: 一个将swagger的Json文件转换为ShowDoc的小工具
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2022-03-24
- **Last Updated**: 2022-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swagger-showdoc

[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
[![GitHub Release](https://img.shields.io/github/release/lerry903/swagger-showdoc.svg)](https://github.com/lerry903/swagger-showdoc/releases)
[![SpringBoot](https://img.shields.io/badge/SpringBoot-2.0.3.RELEASE-brightgreen.svg)](https://docs.spring.io/spring-boot/docs/2.0.3.RELEASE/reference/htmlsingle/)

#### 项目介绍
很多在使用swagger的公司都有一个问题，文档真的可读性不高，在有些情况下，甚至只是开发人员自己能玩，完全不能作为开放文档使用。本项目旨在帮助使用swagger项目的团队，利用现有的swagger.json格式文件来实现文档的自动生成，文档的展示使用了showDoc

#### 软件架构

Spring Boot 2.0.3

JDK 1.8

swagger2markup 1.3.3

okhttp 3.11.0


#### 使用说明

1. 克隆项目
2. 直接运行SwaggerShowDocApplication
3. 访问http://localhost:8080/index.html
4. 输入各种参数，点击"开始文档同步"按钮

#### 源码地址
  - GitHub：https://github.com/lerry903/swagger-showdoc
  - 码云：https://gitee.com/lerry903/swagger-showdoc

#### 参与贡献

1. Fork 本项目
2. 新建分支
3. 提交代码
4. 新建 Pull Request


## License

用户在遵循本项目协议的同时，如果用户下载、安装、使用本项目中所提供的软件，软件作者对任何原因在使用本项目中提供的软件时可能对用户自己或他人造成的任何形式的损失和伤害不承担任何责任。作者有权根据有关法律、法规的变化修改本项目协议。修改后的协议会随附于本项目的新版本中。当发生有关争议时，以最新的协议文本为准。如果用户不同意改动的内容，用户可以自行删除本项目。如果用户继续使用本项目，则视为您接受本协议的变动。

感谢大家 [Star](https://github.com/lerry903/swagger-showdoc/stargazers) & [Fork](https://github.com/lerry903/swagger-showdoc/network/members) 的支持。