https://github.com/tangcent/easy-yapi

Generate API document to yapi
https://github.com/tangcent/easy-yapi

idea-plugin intellij-plugin yapi yapi-plugin

Last synced: 11 months ago
JSON representation

Generate API document to yapi

• Host: GitHub
• URL: https://github.com/tangcent/easy-yapi
• Owner: tangcent
• License: agpl-3.0
• Created: 2019-05-25T14:04:17.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T13:58:40.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T02:37:47.368Z (almost 2 years ago)
• Topics: idea-plugin, intellij-plugin, yapi, yapi-plugin
• Language: Kotlin
• Homepage: https://easyyapi.com
• Size: 25.4 MB
• Stars: 416
• Watchers: 13
• Forks: 139
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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")

English | [中文](README_CN.md)

## Feature

- [Export API Documents](https://easyyapi.com/documents/use.html)

- [Send API requests](http://easyyapi.com/documents/call.html)

|            | Support                                                                                                                                                                                                                                                                                   | Extended Support                  |

|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|

| language   | java, kotlin                                                                                                                                                                                                                                                                              | scala                             |

| web        | [spring](https://spring.io/), [feign](https://spring.io/projects/spring-cloud-openfeign), [jaxrs](https://www.oracle.com/technical-resources/articles/java/jax-rs.html) ([quarkus](https://quarkus.io/) or [jersey](https://eclipse-ee4j.github.io/jersey/))                              | [dubbo](https://dubbo.apache.org) |

| channels   | [Postman](https://easyyapi.com/documents/export2postman.html), [Yapi](https://easyyapi.com/documents/export2yapi.html), [Markdown](https://easyyapi.com/documents/export2markdown.html) , [Curl](https://curl.se/) , [HttpClient](https://plugins.jetbrains.com/plugin/13121-http-client) | -                                 |

| frameworks | javax.validation, Jackson, Gson                                                                                                                                                                                                                                                           | [swagger](https://swagger.io/)    |

## AI Powered (Beta)

EasyYAPI includes powerful AI capabilities to enhance your API documentation workflow:

### Features

- **API Translation**: Automatically translate your API documentation to different languages, preserving technical terms while providing natural language translations.

- **Method Return Type Inference**: Use AI to analyze method code and more accurately infer complex return types, improving API documentation accuracy.

### Configuration

- **Support for Multiple AI Providers**: Configure your preferred AI provider (OpenAI, DeepSeek, etc.) and models (GPT-4, DeepSeek-V3, etc.).

- **API Response Caching**: Optimize performance by caching AI responses for identical requests.

To enable these features, configure your AI provider and API token in the EasyYAPI settings dialog.

## Navigation

* [Guide](https://easyyapi.com/documents/index.html)

* [Installation](https://easyyapi.com/documents/installation.html)

* [Usage](https://easyyapi.com/documents/use.html)

* [Setting](https://easyyapi.com/setting/index.html)

* [Demo](https://easyyapi.com/demo/index.html)

## Run application

- `./gradlew :idea-plugin:runIde` will runs an IDEA instance with the EasyYapi installed.

- `./gradlew clean test` will run all test case.

## Requirements

- IDE: Intellij Idea Ultimate / Intellij Idea Community 2021.2.1 or higher

- JDK: Version 11 or higher

## Compatibility

| JDK | IDE      | status |

|-----|----------|--------|

| 11  | 2021.2.1 | ✓      |

| 15  | 2022.2.3 | ✓      |

| 17  | 2023.1.3 | ✓      |

## Javadoc

- [wiki](https://en.wikipedia.org/wiki/Javadoc)

- [oracle](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html)

- [baike](https://baike.baidu.com/item/javadoc)

## KDoc

- [kotlin-doc](https://kotlinlang.org/docs/reference/kotlin-doc.html)

## Contributing

You can propose a feature request opening an issue or a pull request.

Here is a list of contributors: