# openapi3-doc

**Repository Path**: kedahanzi/openapi3-doc

## Basic Information

- **Project Name**: openapi3-doc
- **Description**: 基于OpenAPI3.x规范定义API，然后将多个API规范文档集成一个doc系统入口中。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-10-17
- **Last Updated**: 2022-03-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenAPI3（OAS3.x）可视化文档

## 构建
./build.sh prod  
在build目录下生成安装包, 执行安装内部的install.sh脚本。  

## 启动方式
supervisorctl update  
supervisorctl start openapi3-doc  
supervisorctl restart openapi3-doc  
supervisorctl stop openapi3-doc  

## API文档地址
http://${serverName}/swagger-ui/index.html

## 配置
在application.properties中设置spring.web.resources.static-locations配置YAML资源根路径.   
所有yaml文件保存在该目录中，服务启动时，自动加载yaml资源。