Metrics
0
Watch 5 Star 4 Fork 1

dongxl123 / apidoc-plugin-ideaJavaMPL-2.0

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

Clone or download
dongxl123 authored 192
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

ApiDoc

  • This is a plugin you can generate apiDoc from request in controller.
  • Please do aware This plugin is only for IntelliJ IDEA.
  • This plugin develop for the npm model apidoc, HomePage, install command npm i apidoc

Install

  • Using IDE built-in plugin system on Windows:
    • File > Settings > Plugins > Browse repositories... > Search for "ApiDoc" > Install Plugin
  • Using IDE built-in plugin system on MacOs:
    • Preferences > Settings > Plugins > Browse repositories... > Search for "ApiDoc" > Install Plugin
  • Manually:
    • From official jetbrains store Download the latest release and install it manually using Preferences > Plugins > Install plugin from disk...

Usage

Use IDE menu

Use hotkey

Default Option + Ctrl + Shift + p(Mac), Alt + Ctrl + Shift + p (win)

Version Info

v1.8

  • fix bug: request url not support annotation attribute path

v1.7

  • Optimizing UI Interface : add regenerate example radiobutton

v1.6

  • Resolve conflict: JavaDocWriter component name collision

v1.5

  • Add ApiDoc Plugin Settings: support set parameter extract object properties max depth

v1.4

  • Optimizing UI Interface

v1.3

  • Support IDEA earlier version since 162+
  • bugFix: responseBody field support special psiType, eg. BigInteger, iterable class...
  • bugFix: remove Deprecated field

v1.2

  • Optimizing Example Data Generation
  • Optimizing UI Interface

v1.1

  • Support Auto Generate Example Data
  • Optimizing UI Interface
  • bugFix: field description should support special char space

v1.0

first version

  • Support UI operation
  • Only Support for public method in Controller with annotation related by httpRequest
  • Supports shortcut to open ApiDoc, default option + ctrl + shift + p (mac), alt + ctrl + shift + p(win)
  • Support to generate apidoc
  • Support to modify the doc with memory feature

Comments ( 3 )

You need to Sign in for post a comment

Help Search

Gitee_sixth 5th_float_left_close