# easy-yapi

**Repository Path**: ciweigg/easy-yapi

## Basic Information

- **Project Name**: easy-yapi
- **Description**: Elegant documentation comes from elegant code comments
- **Primary Language**: Kotlin
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: https://easyyapi.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 10
- **Created**: 2021-05-21
- **Last Updated**: 2021-05-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# easy-yapi

[![Build Status](https://travis-ci.com/tangcent/easy-yapi.svg?branch=master)](https://travis-ci.com/tangcent/easy-yapi)
[![CI](https://github.com/tangcent/easy-yapi/actions/workflows/ci.yml/badge.svg)](https://github.com/tangcent/easy-yapi/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/tangcent/easy-yapi/branch/master/graph/badge.svg?token=J6RUGI54XV)](https://codecov.io/gh/tangcent/easy-yapi)
[![](https://img.shields.io/jetbrains/plugin/v/12458?color=blue&label=version)](https://plugins.jetbrains.com/plugin/12458-easyyapi)
[![](https://img.shields.io/jetbrains/plugin/d/12458)](https://plugins.jetbrains.com/plugin/12458-easyyapi)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/tangcent/easy-yapi.svg)](http://isitmaintained.com/project/tangcent/easy-yapi "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/tangcent/easy-yapi.svg)](http://isitmaintained.com/project/tangcent/easy-yapi "Percentage of issues still open")

## 功能特性
- [导出API文档到`Postman`](https://easyyapi.com/documents/export2postman.html)
- [导出API文档到`Yapi`](https://easyyapi.com/documents/export2yapi.html)
- [导出API文档到`Markdown`](https://easyyapi.com/documents/export2markdown.html)
- [导出RPC文档到`Yapi`](https://easyyapi.com/documents/export_rpc.html)
- [导出RPC文档到`Markdown`](https://easyyapi.com/documents/export_rpc.html)
- [在`IDEA`中直接发起API请求](http://easyyapi.com/documents/call.html)
- Api DashBoard
- YApi DashBoard

## 导航

* [Guide](https://easyyapi.com/documents/index.html)
* [安装](https://easyyapi.com/documents/installation.html)
* [使用](https://easyyapi.com/documents/use.html)
* [配置](https://easyyapi.com/setting/index.html)
* [demo](https://easyyapi.com/demo/index.html)

## 贡献

***您可以通过以下途径帮助easy-yapi变得更好***
  
* 讨论 [新的功能](https://github.com/tangcent/easy-yapi/issues?q=label%3Aenhancement) or提交 [BUG](https://github.com/tangcent/easy-yapi/issues?q=label%3Abug): [Issues](https://github.com/tangcent/easy-yapi/issues)

* 开发 [新的功能](https://github.com/tangcent/easy-yapi/pulls?q=+label%3Aenhancement) or修复 [BUG](https://github.com/tangcent/easy-yapi/pulls?q=label%3Abug): [PR](https://github.com/tangcent/easy-yapi/pulls)

* 完善测试 [codecov](https://codecov.io/gh/tangcent/easy-yapi)

* 帮助维护文档: [easyyapi.com](https://github.com/easyyapi/easyyapi.github.io/tree/dev)
  请将您的PR提交到dev分支
  
* 维护推荐配置: [.recommend.easy.api.config](https://github.com/tangcent/easy-yapi/blob/master/idea-plugin/src/main/resources/.recommend.easy.api.config)

* 丰富支持的三方配置: [third](https://github.com/tangcent/easy-yapi/tree/master/third)

* 丰富demo: [spring-demo](https://github.com/Earth-1610/spring-demo)

* 修复IDE兼容问题: [intellij-kotlin](https://github.com/Earth-1610/intellij-kotlin/pulls?q=label%3Acompatibility+)