yapi

KO | EN

gitlite — search

#python #deep-learning #javascript #hacktoberfest #react #kubernetes #keras #machine-learning #cli #k8s #json #linux

★ 27,724 Open GitHub ↗

YApi는 로컬에 배포할 수 있으며, 프론트엔드, 백엔드, QA를 연결하는 시각화된 인터페이스 관리 플랫폼입니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## YApi 시각화 인터페이스 관리 플랫폼
체험 주소:
[http://yapi.smart-xwork.cn/](http://yapi.smart-xwork.cn/)
문서:

[hellosean1025.github.io/yapi](https://hellosean1025.github.io/yapi)

### 플랫폼 소개
![avatar](https://raw.githubusercontent.com/YMFE/yapi/master/yapi-base-flow.jpg)
YApi는 **효율적**이고, **사용하기 쉬우며**, **기능이 강력한** API 관리 플랫폼으로, 개발, 기획, 테스트 인력에게 더 우수한 인터페이스 관리 서비스를 제공하는 것을 목표로 합니다. 개발자가 API를 손쉽게 생성, 배포, 유지보수할 수 있도록 돕습니다. 또한 YApi는 사용자에게 훌륭한 인터랙션 경험을 제공하며, 개발자는 플랫폼이 제공하는 인터페이스 데이터 쓰기 도구와 간단한 클릭 조작만으로도 인터페이스를 관리할 수 있습니다.
\*\*QQ 커뮤니티 그룹\*\*:
644642474 \*\*메인 그룹은 가득 찼을 수 있습니다\*\*.
941802405 \*\*그룹 2에 오신 것을 환영합니다\*\*
### 특징
\* Json5와 Mockjs를 기반으로 인터페이스 반환 데이터의 구조와 문서를 정의하여 효율성 수십 배 향상
\* 평면화된 권한 설계로 대규모 엔터프라이즈 급 프로젝트 관리 보장 및 사용 편의성 확보
\* postman과 유사한 인터페이스 디버깅
\* 자동화 테스트, Response 어설션(Assertion) 지원
\* MockServer는 일반적인 무작위 mock 지원 외에도 Mock 기대치 기능을 추가하여, 설정된 요청 필터링 규칙에 따라 기대하는 데이터 반환
\* postman, har, swagger 데이터 가져오기 지원
\* 무료 오픈소스, 내부망(Intranet) 배포로 정보 유출 걱정 해소
### 내부망 배포
#### 환경 요구 사항
\* nodejs (7.6+)
\* mongodb (2.6+)
\* git
#### 설치
제공되는 yapi-cli 도구를 사용하면 YApi 플랫폼을 매우 쉽게 배포할 수 있습니다. `yapi server`를 실행하여 시각적 배포 프로그램을 시작하고, 해당 설정을 입력한 후 배포 시작을 클릭하면 전체 웹사이트 배포가 완료됩니다. 배포가 완료된 후 안내 메시지에 따라 `node {웹사이트 경로/server/app.js}`를 실행하여 서버를 시작할 수 있습니다. 브라우저에서 지정된 url을 열고, 로그인을 클릭하여 방금 설정한 관리자 이메일을 입력합니다(기본 비밀번호는 `ymfe.org`이며 시스템 로그인 후 개인 센터에서 변경할 수 있습니다).
```bash
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
```
#### 서비스 관리
pm2를 활용하여 서비스를 편리하게 관리하고 유지보수할 수 있습니다.
```bash
npm install pm2 -g //pm2 설치
cd {프로젝트 디렉토리}
pm2 start "vendors/server/app.js" --name yapi //pm2로 yapi 서비스 관리
pm2 info yapi //서비스 정보 확인
pm2 stop yapi //서비스 중지
pm2 restart yapi //서비스 재시작
```
#### 업그레이드
프로젝트 버전 업그레이드는 매우 쉽고 기존 프로젝트 데이터에 영향을 주지 않으며, vendors 디렉토리 하위의 소스 파일만 동기화됩니다.
```bash
cd {프로젝트 디렉토리}
yapi ls //버전 번호 목록 확인
yapi update //최신 버전으로 업데이트
yapi update -v {Version} //지정된 버전으로 업데이트
```
### 튜토리얼
\* [YApi를 사용하여 API 문서 관리, 테스트, mock하기](https://juejin.im/post/5acc879f6fb9a028c42e8822)
\* [Swagger 인터페이스 데이터를 YApi 플랫폼으로 자동 업데이트](https://juejin.im/post/5af500e251882567096140dd)
\* [자동화 테스트](https://juejin.im/post/5a388892f265da430e4f4681)
\* [GTest(YApi 기반) 인터페이스 개발 효율성 10배 향상 실전](https://mp.weixin.qq.com/s/z66f7bRX8aAOppAtBIB7Uw)
### YApi 플러그인
\* [yapi sso 로그인 플러그인](https://github.com/YMFE/yapi-plugin-qsso)
\* [yapi cas 로그인 플러그인](https://github.com/wsfe/yapi-plugin-cas) By wsfe
\* [yapi gitlab 연동 플러그인](https://github.com/cyj0122/yapi-plugin-gitlab)
\* [oauth2.0 로그인](https://github.com/xwxsee2014/yapi-plugin-oauth2)
\* [rap 플랫폼 데이터 가져오기](https://github.com/wxxcarl/yapi-plugin-import-rap)
\* [dingding](https://github.com/zgs225/yapi-plugin-dding) 딩톡(DingTalk) 로봇 푸시 플러그인
\* [export-docx-data](https://github.com/inceptiongt/Yapi-plugin-export-docx-data) docx 문서로 데이터 내보내기
\* [interface-oauth-token](https://github.com/shouldnotappearcalm/yapi-plugin-interface-oauth2-token) 주기적으로 인증 토큰을 자동 가져오는 플러그인
\* [import-swagger-customize](https://github.com/follow-my-heart/yapi-plugin-import-swagger-customize) 지정된 swagger 인터페이스 가져오기
### 코드 생성
\* [yapi-to-typescript: YApi의 인터페이스 정의에 따라 TypeScript 요청 함수 생성](https://github.com/fjc0k/yapi-to-typescript)
\* [yapi-gen-js-code: YApi의 인터페이스 정의에 따라 JavaScript 요청 함수 생성](https://github.com/hellosean1025/yapi-gen-js-code)
\* [SwiftJSONModeler: YApi의 인터페이스에 따라 Swift 모델 코드 생성](https://github.com/CodeOcenS/SwiftJSONModeler)
### YApi Docker 배포 (비공식)
\* [alpine 버전 docker 이미지를 사용하여 yapi 빠르게 배포하기](https://www.jianshu.com/p/a97d2efb23c5)
\* [docker-yapi: 공식 yapi-cli 기반의 docker-compose 솔루션](https://github.com/Ryan-Miao/docker-yapi)
\* [docker-compose로 yapi 원클릭 배포](https://github.com/jinfeijie/yapi)
\* [docker-YApi: 더욱 사용하기 쉬운 YApi 이미지](https://github.com/fjc0k/docker-YApi)
\* [DockerCompose를 사용하여 Yapi 구축 및 배포](https://github.com/MyHerux/daily-code/blob/master/Program/%E5%B7%A5%E5%85%B7%E7%AF%87/Yapi/%E4%BD%BF%E7%94%A8DockerCompose%E6%9E%84%E5%BB%BA%E9%83%A8%E7%BD%B2Yapi.md)
\* [yapi-docker: dockerized yapi deployment all in one](https://github.com/williamlsh/yapi-docker)
### YApi 관련 도구
\* [Api Generator](https://github.com/Forgus/api-generator) 인터페이스 문서 자동 생성 플러그인 (무침투)
\* [mysql 서비스 http 도구, 자동화 테스트와 연동 가능](https://github.com/hellosean1025/http-mysql-server)
\* [idea 인터페이스 yapi 업로드 원클릭 플러그인](https://github.com/diwand/YapiIdeaUploadPlugin)
\* [idea 인터페이스 업로드 및 디버깅 플러그인 easy-yapi](https://easyyapi.com/)
\* [postgres sql을 실행하는 서비스](https://github.com/shouldnotappearcalm/http-postgres-server)
\* [SpringBoot 의존성 기반 YApi 자동 생성](https://github.com/NoBugBoy/YDoc)
\* [Yapi X 원클릭 인터페이스 문서 생성, yapi, rap2, eolinker 등에 업로드 (IDEA 플러그인)](https://github.com/jetplugins/yapix)
### YApi 주요 고객사
\* 취나루 (Qunar)
\* 씨이트립 (Ctrip)
\* 이롱 (eLong)
\* 메이퇀 (Meituan)
\* 바이두 (Baidu)
\* 텐센트 (Tencent)
\* 알리바바 (Alibaba)
\* 징동 (JD.com)
\* 진리일요 (Toutiao)
\*  vip.com 페이
\* 롄자 (Lianjia)
\* 콰이쇼우 (Kuaishou)
\* 비니펀 (Bianlifeng)
\* 중상후이민 (Zhongshang Huimin)
\* 시나 (Sina)
\* VIPKID
\* 마펑워 (Mafengwo)
\* 밴피쉬 (Banfish)
\* 旷视科技 (Megvii)
### Authors
\* [hellosean1025](https://github.com/hellosean1025)
\* [gaoxiaomumu](https://github.com/gaoxiaomumu)

gaoxiaomumu)
\* [zwjamnsss](https://github.com/amnsss)
\* [dwb1994](https://github.com/dwb1994)
\* [fungezi](https://github.com/fungezi)
\* [ariesly15](https://github.com/ariesly15)
### License
Apache License 2.0

yapi

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README