Watch 1 Star 1 Fork 0

tangcent / easy-yapiKotlinAGPL-3.0

Sign up for free
Explore and code with more than 2 million developers,Free private repositories !:)
Sign up
easyapi for yapi spread retract

Clone or download
Loading...
README.md

easy-yapi

Javadoc

Tips

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

  1. Please commit a issue.
  2. Try roll back to the previous version.
  3. 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"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"

Feature

  • 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

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

Doc Type Postman Markdown Yapi
spring api ✅️ ✅️ ✅️
method doc(rpc) ❌️️

Comments ( 0 )

You need to Sign in for post a comment

Kotlin
1
https://gitee.com/tangcent/easy-yapi.git
git@gitee.com:tangcent/easy-yapi.git

Help Search