1 Star 0 Fork 9

如果没有你 / easy-yapi

forked from tangcent / easy-yapi 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
README_en.md 6.25 KB
一键复制 编辑 原始数据 按行查看 历史
tangcent 提交于 2021-03-13 14:59 . chore: support co (#391)

easy-yapi

Build Status CI codecov Average time to resolve an issue Percentage of issues still open Gitter

Table of Contents

Feature

  • Support Java&Kotlin
  • Support Spring
  • Export api to Postman
  • Export api to Yapi
  • Export api to Word
  • Export api to Markdown
  • Export method doc(rpc) to Markdown
  • Export method doc(rpc) to Yapi
  • Call api from code
  • Api DashBoard
  • YApi DashBoard

Javadoc

KDoc

Installation

support following product build version > 173(2017.3)

  • IntelliJ IDEA
  • IntelliJ IDEA Community Edition

using IDE plugin system

  • Preferences(Settings) > Plugins > Browse repositories... > find"EasyYapi" > Install Plugin

Manual:

  • download from Jetbrains or Github -> Preferences(Settings) > Plugins > Install plugin from disk...

restart IDE.

Guide

  • docs

  • ExportApi(0.8.2.1+)

    1. Open existed Spring Controller File Or Select files or directories from project navigation
    You can use by this : "alt shift E(windows)/ctrl E(mac)"
    2. Select apis and channel
    3. Click [✔️] button or press enter key
  • ExportYapi
    There are two ways to export api.
    1. Open existed Spring Controller File
    You can use by this : "Right click in the file -> generate... " or use its shortcuts "[Alt + Insert]/[Ctrl+Enter]" , then
    choose the action "ExportYapi"
    2. Select files or directories from project navigation
    You can use by this : "Click [Code -> ExportYapi] in top"
  • ExportPostman
    There are two ways to export api.
    1. Open existed Spring Controller File
    You can use by this : "Right click in the file -> generate... " or use its shortcuts "[Alt + Insert]/[Ctrl+Enter]" , then
    choose the action "ExportPostman"
    2. Select files or directories from project navigation
    You can use by this : "Click [Code -> ExportPostman] in top"
  • How to export to postman automatically?
    Click [Preference -> Other Setting -> EasyApi]
    set postman privateToken
    If you do not have a privateToken of postman,
    you can easily generate one by heading over to the Postman Integrations Dashboard
    [https://go.postman.co/integrations/services/pm_pro_api]
  • Quick API requests from code
    Open existed Spring Controller File
    You can use by this : "Right click in the file -> generate... " or use its shortcuts "[Alt + Insert]/[Ctrl+Enter]" , then
    choose the action "Call"
  • ApiDashBoard
    It is easily to export api in current project to postman by dragging
    You can use by this : "Click [Code -> ApiDashBoard] in top"
  • YApiDashBoard
    It is easily to export api in current project to yapi by dragging
    You can use by this : "Click [Code -> YApiDashBoard] in top"
  • ExportMarkdown(Beta)
    There are two ways to export api.
    1. Open existed Spring Controller File
    You can use by this : "Right click in the file -> generate... " or use its shortcuts "[Alt + Insert]/[Ctrl+Enter]" , then
    choose the action "ExportMarkdown"
    2. Select files or directories from project navigation
    You can use by this : "Click [Code -> ExportMarkdown] in top"

Support:

Doc Type Postman Markdown Yapi
spring api yes yes yes
method doc(rpc) yes yes yes
Kotlin
1
https://gitee.com/ciweigg/easy-yapi.git
git@gitee.com:ciweigg/easy-yapi.git
ciweigg
easy-yapi
easy-yapi
master

搜索帮助