easy-api

Simplifies API Development
Parsing based on javadoc

Javadoc

wiki
oracle

Tips

Before the 1.0.0 release, easy-api will be quick iteration. If you encounter a failure

Please commit a issue.
Try roll back to the previous version.
Feel free to email me at any time.

Version

$major.$minor.$min_support.$max_support.$fix

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"EasyApi" > Install Plugin

Manual:

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

restart IDE.

Guide

custom config for project
ExportApi(0.8.2+)

    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

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" , 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" , 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"

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" , then
    choose the action "ExportMarkdown"
    2. Select files or directories from project navigation
    You can use by this : "Click [Code -> ExportMarkdown] in top"

Feature

Support: ✅️=yes,❌️️=no

doc type	Postman	Markdown
spring api	✅	✅
method doc(rpc)	❌	✅

echo-layker/easy-api