# swaggerWithShowDoc

**Repository Path**: lunbobi/swaggerWithShowDoc

## Basic Information

- **Project Name**: swaggerWithShowDoc
- **Description**: 很多在使用swagger的公司都有一个问题，文档真的可读性不高，在有些情况下，甚至只是开发人员自己能玩，完全不能作为开放文档使用。本项目旨在帮助使用swagger项目的团队，利用现有的swagger.json格式文件来实现文档的自动生成，文档的展示使用了showDoc，希望大家偷懒成功~~
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 3
- **Created**: 2018-06-01
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swaggerWithShowDoc

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

#### 软件架构
软件架构说明


#### 安装教程

1. xxxx
2. xxxx
3. xxxx

#### 使用说明

1. xxxx
2. xxxx
3. xxxx

#### 参与贡献

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


#### 码云特技

1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5. 码云官方提供的使用手册 [http://git.mydoc.io/](http://git.mydoc.io/)
6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)