k8sclub/yapi repository overview

⁠yapi

• Docs for English⁠
• 中文文档⁠

YMFE/yapi⁠ is a visualized interface management platform that can be deployed locally, connecting frontend and backend end and QA engineers. https://hellosean1025.github.io/yapi/⁠

This project is created to:

• build image automaticlly
• quick start Yapi (docker or kubernetes)

for YMFE/yapi⁠.

⁠Reference

• YMFE/yapi - GitHub⁠
• YApi Document⁠ (Chinese only for now)
  • Yapi deploy locally⁠
• mongo - DockerHub⁠
• mongo-express - DockerHub⁠

⁠Quick Start

# Clone
git clone https://github.com/icmdb/yapi.git

# Enter yapi directory
cd yapi

# Pull images: yapi,mongo,mongi-express
docker-compose pull

# This may take 30 seconds for yapi-mongo get ready.
docker-compose up -d

# Remove (Carefully)
docker-compose down
rm -rf ./yapidata

# Restart yapi
docker restart yapi
##  or
docker-compose restart yapi

Then you can access:

• Details see:
  • docker-compose.yml⁠
  • docker-entrypoint.sh⁠
  • docker logs yapi or docker-compose logs yapi
• You can change configs in docker-compose.yml, then run: docker-compose up -d to recreate container.

⁠Deploy in kubernetes

# Set your own domain
YAPI_DOMAIN="domain.com"

git clone [email protected]:icmdb/yapi.git

cd yapi/k8s

grep icmdb.vip -rl ./ | xargs sed -i 's#icmdb.vip#${YAPI_DOMAIN}#g'

kubectl apply -f .

⁠FAQ & Feedback

Try to iterms below if you have problems:

• Check logs by run: docker logs yapi.
• Create a database named yapi by yapi-mongo-express http://127.0.0.1:8081⁠

⁠Todo List

• README_CN.md
• Backup mongodata
• Yaml for k8s
• Helm Charts
• Plugins
  • sso
  • cas
  • oauth2.0
  • rap
  • dingding
  • export-docx-data
  • interface-oauth-token
  • import-swagger-customize