Forgus/easy-yapi

easyapi for yapi

KotlinAGPL-3.0

easy-yapi

Customized easyApi for yapi
中文 | English
demo

Installation

support following product build version > 173

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

custom config for project
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" , 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" , 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