Skip to content

Latest commit

 

History

History
114 lines (89 loc) · 2.84 KB

README.md

File metadata and controls

114 lines (89 loc) · 2.84 KB
Raw

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)

Examples

  • operation steps avatar

  • use npm command apidoc, to generate html avatar

Version Info

v3.0.5

  • new features: output field name support snake case

v3.0.4

  • new features: request method support PATCH

v3.0.2

  • new features: request parameter support class MultipartFile

v3.0.1

  • new features: persistent version

v3.0.0

  • support version since 192
  • Resolve conflict: timeout

v2.3

  • fix bug: request url

V2.2

  • fix bug: parameter parse error with annotation @RequestBody in some cases, like List<Object>, Object[]

v2.1

  • add pluginIcon.svg
  • fix bug: example data generate error when in some cases

v2.0

  • Support IDEA earlier version since 192+

v1.8

  • fix bug: request url not support annotation attribute path
  • fix bug: generic parameter parse error in some cases
  • create branch 191 to support idea (162.* - 191.*)

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