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-v2.6.5

Published by shalousun over 1 year ago

smart-doc - smart-doc-2.2.7

Published by shalousun about 3 years ago

Bug Fixes

  • Fix css reference error in dubbo document.
  • Fix grouping logic errors.
  • Fix the bug of replacing incorrectly when the path constants are similar.
  • JSR303 group optimization, the group field marked with Null will no longer be displayed in the document.
smart-doc - smart-doc-2.2.6

Published by shalousun about 3 years ago

Bug Fixes

  • Fix html document static resource reference error.
  • Modify the grouping strategy, do not group when the group option is not set.
  • Fix catalog item search error after grouping.
  • Optimize the maven plugin prompt.
smart-doc - smart-doc-2.2.5

Published by shalousun about 3 years ago

This version is deprecated.

smart-doc - smart-doc-2.2.4

Published by shalousun about 3 years ago

New Features

  • Added support for jsr303 @size and @length.
  • Added isReplace option.

Bug Fixes

  • Fix the error when the dictionary code is pushed to torna.
  • Fix html template style error.
  • Fix postman error #I41G2E.
smart-doc - smart-doc-2.2.3

Published by shalousun about 3 years ago

New Features

  • Add pathPrefix option to configure web context .
  • Support parsing constants in request headers .
  • Support using JsonIgnoreProperties and JSONType annotations to ignore fields .
  • Support the configuration of the global request parameters set in the add interceptor, #https://github.com/smart-doc-group/smart-doc/issues/132.

Bug Fixes

  • Modify the issue that allInOneDocFileName is invalid for some documents, #131.
  • Fix the problem that some types of mocks are not pushed to Torna.
smart-doc - smart-doc-2.2.2

Published by shalousun over 3 years ago

New Features

  • Add ignore HttpServlet object .
  • Built-in Jpa Pageable paging processing. Like swagger PageableAsQueryParam.
  • The gradle plugin adds support for gradle 7.x version

Enhancement

  • Enhance the processing of html special characters in the document, and solve the display error after html rendering.
  • Enhanced request header settings to support configuring two attributes urlPatterns and excludePathPatterns to match the corresponding interface.
  • Optimized the prompt of the maven plug-in. The path of the loaded code can be printed to the console.
  • Enhance the configuration of packageFilters, which can be configured using regular expressions

Bug Fixes

  • Fix the problem of smart-doc parsing errors when using regular expressions in URLs.
  • Fix json formatting error .
  • Fix dictionary code template error , #119 .
  • Fix the data error of dubbo rpc interface document pushed to torna .
  • Fix the bug that fields with the same name from different classes in customResponseFields and customRequestFields are overwritten
smart-doc - smart-doc-2.2.1

Published by shalousun over 3 years ago

  • Remove unnecessary System.out.print printing in the code.
smart-doc - smart-doc-2.2.0

Published by shalousun over 3 years ago

New Features

  • Add @response tag. Support custom setting response example
  • Added analysis of Character type.
  • Remove YapiBuilder .

Bug Fixes

  • Fix the comment extraction error when the parameter comment is multiple lines .
  • Fix the sample error of pushing to Torna when the interface is returned as an array
  • Fix the parsing error when using the JobDataMap type from Quartz.
  • Fix potential null pointers in the code.
smart-doc - smart-doc-2.1.9

Published by shalousun over 3 years ago

New Features

  • Add multi-level generic nesting parsing support
  • Add dynamic selection of css cdn based on locale.
  • Added to push the interface sort number to torna.

Enhancement

  • Enhance the automatic recognition of Spring file download objects, and reduce the manual tag @download tag.
  • Optimized dictionary code push. When the dictionary code is empty, no push request will be sent to torna.

Bug Fixes

  • Fix the bug that the enumeration is displayed in the parameter when inlineEnum is false.
  • Fix the bug that the value of LocalDateTime type field in the parent class generated by smart-doc is wrong when the parent class is generic.
  • Fix the bug that the @ignore tag on the class does not take effect.
smart-doc - smart-doc-2.1.8

Published by shalousun over 3 years ago

New Features

  • Added to push business error codes and definition dictionaries to Torna.
  • Add @JsonProperty support, support JsonProperty.Access control field.

Enhancement

  • When @RestController annotation is added to the parent class, the subclass can be recognized and scanned by smart-doc

Bug Fixes

  • Fix the problem that some mock values are lost after pushing interface document data to Torna.
  • Fix the bug of parsing non-class names into class names when configuring class substitution in parameter comments.
  • Fix the bug that the two tasks of the maven plugin torna-rest and torna-rpc do not add the compilation prefix.
  • Fix the bug that the array type json example is wrong.
  • Fix the bug that setting field value in customRequestFields does not take effect.
smart-doc - smart-doc-2.1.7

Published by shalousun over 3 years ago

Bug Fixes

  • Fix the extra question mark bug of curl command when there are no parameters
  • Fix the bug of data error after the author's information is pushed to Torna.
smart-doc - smart-doc-2.1.6

Published by shalousun over 3 years ago

New Features

  • Added push author info to torna
  • Added push QueryParams parameter to torna

Bug Fixes

  • Fix the bug that the file upload object in List cannot be parsed.
smart-doc - smart-doc-2.1.5

Published by shalousun over 3 years ago

New Features

  • Added push dubbo rpc interface document to Torna.

Bug Fixes

  • Fix the bug that the RequestBodyAdvice request sample is missing.
smart-doc - smart-doc-2.1.4

Published by shalousun over 3 years ago

New Features

  • Added RequestBodyAdvice support

Bug Fixes

  • Fix the bug that the Mapping of the parent class is not inherited when Controller is inherited
  • Fix the problem of mandatory checking error of binding enumeration in non-json request collection.
  • Fix the bug that the type is object when the generic type is List data.
  • Fix the problem of invalid configuration when customFiled is an inherited parameter.
smart-doc - smart-doc-2.1.3

Published by shalousun over 3 years ago

New Features

  • Add customRequestFields configuration item, #97.

Enhancement

  • Enhanced support for file upload .

Bug Fixes

  • Fix the bug that pathParams is missed when pushing to torna.
  • Modify debug test page to support post form request .
  • Fix the bug that the default value of the enumeration field in the form request object is wrong
smart-doc - smart-doc-2.1.2

Published by shalousun over 3 years ago

Bug Fixes

  • Fix the stack overflow problem of Map nesting in some structures.
  • Fix some bugs in pushing document data to Torna.
smart-doc - smart-doc-2.1.1

Published by shalousun over 3 years ago

Bug Fixes

  • Fix the stack overflow problem of Map nesting in some structures.
  • Fix some bugs in pushing document data to Torna.
smart-doc - smart-doc-2.1.0

Published by shalousun over 3 years ago

New Features

  • Postman url add protocol.
  • Add ignoreParams tag.
  • Support the url suffix of the old SpringMVC project.

Bug Fixes

  • Fix the bug of pushing documents to torn .
smart-doc - smart-doc-2.0.9

Published by shalousun over 3 years ago

New Features

  • Support UUID and ZonedDateTime field types, #89 .
  • Add Torna support for document automation .