smart-doc

Smart-doc is a java restful api document generation tool. Smart-doc is based on interface source code analysis to generate interface documentation, completely zero-injection.

APACHE-2.0 License

Stars
1.4K

Bot releases are hidden (Show)

smart-doc - smart-doc-1.9.1

Published by shalousun about 4 years ago

Bug Fixes

  • Fix the display error of dubbo method name.
  • Fix generic parsing errors.

Enhancement

  • support dubbo 2.7.7 #47 .
smart-doc - smart-doc-1.9.0

Published by shalousun about 4 years ago

New Features

  • Added display control configuration items for request and response examples.
  • Add configuration of custom settings document name.

Bug Fixes

  • Modify the problem that jackson JsonIgnore annotation does not take effect in the parameter object .
  • Modify the problem that the default group verification is ignored when using JSR303 parameter verification.
  • Modify the dubbo api document to display confusion.
smart-doc - smart-doc-1.8.9

Published by shalousun over 4 years ago

New Features

  • Support constant parsing.

Bug Fixes

  • Fix git #38 .
  • Fix gitee #I1LBKO.
  • Fix git #39 generic parsing error.
smart-doc - smart-doc-1.8.8

Published by shalousun over 4 years ago

New Features

  • Add Feign support.

Enhancement

  • Optimized the display of enumerated parameters and supports custom control display.
  • Optimize recursive execution and provide a limit to the number of recursive times.

Bug Fixes

  • Ignore the analysis of LinkedHashMap .
  • Modifying the interface or merging analysis with the implementation class is a field duplication problem.
  • Optimization interface method field can not get docletTag problem.
smart-doc - smart-doc-1.8.7

Published by shalousun over 4 years ago

New Features

  • Added support for Apache Dubbo RPC interface documentation.
  • Added conversion of field format from camel to underline.
  • The maven plugin and gradle plugin provide includes configuration for loading third-party libraries.
  • Added document interface sorting function according to interface title.

Enhancement

  • Enhance the analysis of java interface.
  • Enhance the analysis of the method of using @RequestBody to bind parameters.

Bug Fixes

  • fix #32 .
smart-doc - smart-doc-1.8.6

Published by shalousun over 4 years ago

New Features

  • Added LocalTime support.
  • The smart-doc-gradle-plugin is released for the first time.

Enhancement

  • Optimize the filtering of smart-doc-maven-plugin loading source, support the use of wildcards to filter.

Bug Fixes

  • Optimized the default setting of header when smart-doc exported Postman collection
  • fix #28 。
smart-doc - smart-doc-1.8.5

Published by shalousun over 4 years ago

Enhancement

  • Add @PatchMapping support.
  • Support the use of an object to replace the interface parameter object to complete better document rendering.

Bug Fixes

  • Fixed maven plugin class loader loading enum class error.
  • Fixed When the request parameters are generic, smart-doc parsing generates documentation errors.
  • Fixed the problem of group verification null pointer, do not perform group verification processing on returned objects.
  • Optimize smart-doc-maven-plugin support for multi-level maven projects.
smart-doc - smart-doc-1.8.4

Published by shalousun over 4 years ago

Enhancement

  • Support to ignore specified Spring MVC Controller.#24
  • Enhanced support for complex parameter group validation.

Bug Fixes

  • Fixed bug with infinite parsing of HttpSession objects.
  • Modify the smart-doc-maven-plugin default character set encoding to UTF-8.
smart-doc - smart-doc-1.8.3

Published by shalousun over 4 years ago

Enhancement

  • Support multiple presentation of multiple authors into a document.
  • Supports reading comments from the getter or setter methods of the java interface as field comment information.

Bug Fixes

  • Modify the default encoding to UTF-8.correctly.
smart-doc - smart-doc-1.8.2

Published by shalousun over 4 years ago

New Features

  • Added @Validated grouping support.

Bug Fixes

  • Fixed the problem that the input parameters of Date type interface could not be displayed in the document correctly.
  • Fix wrong title setting in document template.
  • Fixed parsing errors of array type interface input parameters.
smart-doc - smart-doc-1.8.1

Published by shalousun over 4 years ago

New Features

  • Added @Deprecated annotation interface support.

Bug Fixes

  • Fix the bug that the request example put the header into the common parameter after the 1.8.0 refactor.
  • Fix the parameter without the parameter information after @Validated annotation.
  • Upgrade and release the smart-doc-maven-plugin 1.0.2 plugin to solve the problem of using the plugin in the maven project.
smart-doc - smart-doc-1.8.0

Published by shalousun almost 5 years ago

New Features

  • Enhanced support for spring mvc form parameter binding.
  • Merge github book html5 template from fork branch, add search and anchor.
  • Added custom @mock tag for specifying field mock value of JavaBean
  • Enhanced support for jsr303 validation annotations.
  • Enhanced support for spring mvc file upload parameter binding.

Bug Fixes

  • Fix postman json data error generated by smart-doc. #19 #16 #14 #15
  • Fix smart-doc-maven-plugin does not support maven multi-module project. #17
smart-doc - smart-doc-1.7.9

Published by shalousun almost 5 years ago

New Features

  • Release smart-doc-maven-plugin 1.0.0.
  • Support show author.
  • Added ApiDataBuilder to get document data generated by smart-doc, including header, dictionary, error code, etc.
  • Support for binding arrays using @PathVariable annotation

Bug Fixes

  • Fix request error generated by smart-doc. #9
smart-doc - smart-doc-1.7.8

Published by shalousun almost 5 years ago

New Features

  • Support setting project name in html document.
  • Add and export PostMan json data.

Bug Fixes

  • Fix smart-doc parsing endless loop when using Void type in generics. #4
  • Fixed enumeration parameter parsing with a null pointer exception. #5
smart-doc - smart-doc-1.7.7

Published by shalousun almost 5 years ago

New Features

  • Optimized the parsing of java.util.concurrent.ConcurrentMap.

Bug Fixes

  • Fix bug of creating json example for timestamp type field.
  • Fix the problem of smart-doc analysis error when multiple sets of values in the Spring Boot url path.
  • Modify some URLs to generate white space.
smart-doc - smart-doc-1.7.6

Published by shalousun almost 5 years ago

New Features

  • Add request parameter enum field parsing (trial function).

Bug Fixes

  • Solve the problem of repeated header rendering to the document.
  • Solve null pointer error without setting dataDictionaries.
smart-doc - smart-doc-1.7.5

Published by shalousun almost 5 years ago

New Features

  • Optimize the title of the error list in the document to display Chinese or English according to locale changes.
  • Supports circular dependency analysis.
  • Support setting project name as first-level title of markdown.
  • Add an overlay configuration item that generates AllInOne. By default, the version number is not automatically overwritten.
  • Added the ability to enumerate dictionary codes to a document.

Bug Fixes

  • Solve the bug that the internal classes in the external jar of the project generate documentation errors.
  • Modified the display of Content-Type of the interface when uploading using SpringMvc or SpringBoot.
  • Modify the html link jump error caused by the same method comment.
smart-doc - smart-doc-1.7.4

Published by shalousun almost 5 years ago

New Features

  • Optimize the title display of the error list, after optimization, change according to language settings.
  • Optimize the AllInOne.md template, and the generated interface document automatically adds serial numbers.

Bug Fixes

  • Fix bug #I1426C on Gitee.
  • Fix bug #I13ZAL on Gitee.
  • Fix bug #I13U4C on Gitee.
smart-doc - smart-doc-1.7.3

Published by shalousun almost 5 years ago

New Features

  • HTML5 doc support dropdown.
  • ApiMethodDoc add methodId and name field.

Bug Fixes

  • Fix bug #I13R3K on Gitee
  • Fix bug #I13NR1 on Gitee
smart-doc - smart-doc-1.7.2

Published by shalousun almost 5 years ago

New Features

  • Support Spring Mvc @RequestHeader annotation.
  • Support Javadoc @ApiNote tag.
  • Support Spring Mvc @RequestParam set value and default value.
  • Support Spring Mvc ResponseEntity return data analysis.
  • Support inner class analysis.

Bug Fixes

  • Fix line break processing errors.
  • Optimize the documentation generated by AllInOne template. Third-party js library support is not friendly.
  • Fix analysis error,see Gtiee ##I13NR1, #I135PG.