{"id":13679115,"url":"https://github.com/tangcent/easy-yapi","last_synced_at":"2025-04-04T16:17:13.354Z","repository":{"id":37743321,"uuid":"188573368","full_name":"tangcent/easy-yapi","owner":"tangcent","description":"Generate API document to yapi","archived":false,"fork":false,"pushed_at":"2024-04-13T13:58:40.000Z","size":26588,"stargazers_count":416,"open_issues_count":44,"forks_count":139,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-04-14T02:37:47.368Z","etag":null,"topics":["idea-plugin","intellij-plugin","yapi","yapi-plugin"],"latest_commit_sha":null,"homepage":"https://easyyapi.com","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tangcent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-05-25T14:04:17.000Z","updated_at":"2024-04-15T15:17:47.356Z","dependencies_parsed_at":"2022-07-10T14:32:02.355Z","dependency_job_id":"70b31dbd-42a4-4dbe-83e5-4ffa2c7faaa9","html_url":"https://github.com/tangcent/easy-yapi","commit_stats":null,"previous_names":[],"tags_count":148,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tangcent%2Feasy-yapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tangcent%2Feasy-yapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tangcent%2Feasy-yapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tangcent%2Feasy-yapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tangcent","download_url":"https://codeload.github.com/tangcent/easy-yapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247208190,"owners_count":20901570,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["idea-plugin","intellij-plugin","yapi","yapi-plugin"],"created_at":"2024-08-02T13:01:02.122Z","updated_at":"2025-04-04T16:17:13.333Z","avatar_url":"https://github.com/tangcent.png","language":"Kotlin","readme":"# easy-yapi\n\n[![CI](https://github.com/tangcent/easy-yapi/actions/workflows/ci.yml/badge.svg)](https://github.com/tangcent/easy-yapi/actions/workflows/ci.yml)\n[![codecov](https://codecov.io/gh/tangcent/easy-yapi/branch/master/graph/badge.svg?token=J6RUGI54XV)](https://codecov.io/gh/tangcent/easy-yapi)\n[![](https://img.shields.io/jetbrains/plugin/v/12458?color=blue\u0026label=version)](https://plugins.jetbrains.com/plugin/12458-easyyapi)\n[![](https://img.shields.io/jetbrains/plugin/d/12458)](https://plugins.jetbrains.com/plugin/12458-easyyapi)\n[![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\")\n[![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\")\n\nEnglish | [中文](README_CN.md)\n\n## Feature\n\n- [Export API Documents](https://easyyapi.com/documents/use.html)\n- [Send API requests](http://easyyapi.com/documents/call.html)\n\n|            | Support                                                                                                                                                                                                                                                                                   | Extended Support                  |\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|\n| language   | java, kotlin                                                                                                                                                                                                                                                                              | scala                             |\n| 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) |\n| 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) | -                                 |\n| frameworks | javax.validation, Jackson, Gson                                                                                                                                                                                                                                                           | [swagger](https://swagger.io/)    |\n\n## AI Powered (Beta)\n\nEasyYAPI includes powerful AI capabilities to enhance your API documentation workflow:\n\n### Features\n\n- **API Translation**: Automatically translate your API documentation to different languages, preserving technical terms while providing natural language translations.\n- **Method Return Type Inference**: Use AI to analyze method code and more accurately infer complex return types, improving API documentation accuracy.\n\n### Configuration\n\n- **Support for Multiple AI Providers**: Configure your preferred AI provider (OpenAI, DeepSeek, etc.) and models (GPT-4, DeepSeek-V3, etc.).\n- **API Response Caching**: Optimize performance by caching AI responses for identical requests.\n\nTo enable these features, configure your AI provider and API token in the EasyYAPI settings dialog.\n\n## Navigation\n\n* [Guide](https://easyyapi.com/documents/index.html)\n* [Installation](https://easyyapi.com/documents/installation.html)\n* [Usage](https://easyyapi.com/documents/use.html)\n* [Setting](https://easyyapi.com/setting/index.html)\n* [Demo](https://easyyapi.com/demo/index.html)\n\n## Run application\n\n- `./gradlew :idea-plugin:runIde` will runs an IDEA instance with the EasyYapi installed.\n- `./gradlew clean test` will run all test case.\n\n## Requirements\n\n- IDE: Intellij Idea Ultimate / Intellij Idea Community 2021.2.1 or higher\n- JDK: Version 11 or higher\n\n## Compatibility\n\n| JDK | IDE      | status |\n|-----|----------|--------|\n| 11  | 2021.2.1 | ✓      |\n| 15  | 2022.2.3 | ✓      |\n| 17  | 2023.1.3 | ✓      |\n\n## Javadoc\n\n- [wiki](https://en.wikipedia.org/wiki/Javadoc)\n- [oracle](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html)\n- [baike](https://baike.baidu.com/item/javadoc)\n\n## KDoc\n\n- [kotlin-doc](https://kotlinlang.org/docs/reference/kotlin-doc.html)\n\n## Contributing\n\nYou can propose a feature request opening an issue or a pull request.\n\nHere is a list of contributors:\n\n\u003ca href=\"https://github.com/tangcent/easy-yapi/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=tangcent/easy-yapi\" /\u003e\n\u003c/a\u003e\n","funding_links":[],"categories":["Kotlin"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftangcent%2Feasy-yapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftangcent%2Feasy-yapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftangcent%2Feasy-yapi/lists"}