README_en.md

easy-yapi

• Customized easyApi for yapi

• Parsing based on javadoc&KDoc

• 中文 | English

• demo

• QA

Table of Contents

• 1 Feature
• 2 Doc
  • 2.1 Javadoc
  • 2.2 KDoc
• 3 Installation
• 4 Guide
• 5 Support
• 6 Changelog
• 7 Docs
  • 7.1 Config
  • 7.2 Supported-custom-rules
  • 7.3 Support-local-groovy-extension

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

• wiki
• oracle
• baike

KDoc

• kotlin-doc

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
method doc(rpc)