Skip to content

Releases: TongchengOpenSource/smart-doc

smart-doc-v3.0.9

24 Nov 07:25
42e8714
Compare
Choose a tag to compare

What's Changed

  • chore(deps): bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.5 to 3.2.6 by @dependabot in #923
  • chore(deps): bump org.sonatype.central:central-publishing-maven-plugin from 0.5.0 to 0.6.0 by @dependabot in #929
  • chore(deps): bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.6 to 3.2.7 by @dependabot in #928
  • chore(deps-dev): bump org.junit.jupiter:junit-jupiter from 5.11.0 to 5.11.1 by @dependabot in #927
  • chore(deps): bump org.apache.maven.plugins:maven-javadoc-plugin from 3.10.0 to 3.10.1 by @dependabot in #931
  • chore(deps-dev): bump org.junit.jupiter:junit-jupiter from 5.11.1 to 5.11.2 by @dependabot in #930
  • fix: 🐛 Fix empty JSON example value for Map with enum keys and primitive values by @linwumingshi in #924
  • chore(deps-dev): bump org.junit.jupiter:junit-jupiter from 5.11.2 to 5.11.3 by @dependabot in #933
  • fix: 🐛 resolve incorrect parsing of constants in @JsonProperty and @JSONField annotation by @linwumingshi in #935
  • fix: 🐛 Resolve NPE in Postman API doc generation when no methods are present by @linwumingshi in #938
  • fix: 🐛 Resolve error caused by EmptyList being final by @linwumingshi in #941
  • refactor(url): Refactor URL-related code by @linwumingshi in #942
  • ci: 👷 add GitHub Actions workflow to comment on PR by @linwumingshi in #943
  • chore(deps): bump org.apache.maven.plugins:maven-javadoc-plugin from 3.10.1 to 3.11.1 by @dependabot in #944
  • Fix issue If there are enumerations in the query request parameters, the generated request parameter comments will not include 'See'. by @jasonkung22 in #945
  • fix: Fix issue If the request parameter contains type "date" and the parameter name is endTime or beginTime, the resulting example value may be different from what you expect. by @jasonkung22 in #948
  • fix: 🐛 correct example value generation for enums annotated with @JsonValue by @linwumingshi in #952
  • refactor (Enum): Optimize the handling logic for enum parameter types by @linwumingshi in #954
  • ci: 👷 add PR comment notification for build and API doc generation by @linwumingshi in #956
  • fix: Fixed issue caused by isQueryParam error by @jasonkung22 in #957
  • release: 3.0.9 by @shalousun in #959

New Contributors

Full Changelog: 3.0.8...3.0.9

smart-doc-v3.0.8

16 Sep 03:10
bae5a52
Compare
Choose a tag to compare

What's Changed

  • ignore JGit and Data Faker dependencies by @linwumingshi in #896
  • chore(deps): bump org.apache.maven.plugins:maven-javadoc-plugin from 3.7.0 to 3.8.0 by @dependabot in #894
  • Corrected incorrect use of 'version' to 'versions' in Dependabot config by @linwumingshi in #897
  • Handle single @ServerEndpoint property values correctly by @linwumingshi in #902
  • refactor(torna-builder): streamline Torna API documentation generation by @linwumingshi in #903
  • Feat ✨ Split transient field serialization into request and response flags by @linwumingshi in #904
  • ci: 👷 run TornaApiTest in CI workflow by @linwumingshi in #905
  • Fix NATIVE_NOT_ALLOWED when generate REST JMeter.jmx on linux by @linwumingshi in #908
  • feat: Fix the issue where the JsonValue annotation cannot be used on an enum. by @shalousun in #910
  • feat: Enum in the form skips parsing of JsonValue annotation. by @shalousun in #911
  • feat(params): add support for nested map parameter handling by @linwumingshi in #914
  • feat(enum): Support @JsonValue annotation on enum fields by @linwumingshi in #916
  • Fix resolve stack overflow from duplicate ApiParam IDs with enum key Maps by @linwumingshi in #917
  • Refine build logs handling and error reporting in GitHub Actions by @linwumingshi in #918
  • feat: bump common-util to 2.2.6 by @shalousun in #919
  • feat: Support Postman collection grouping by @shalousun in #920

Full Changelog: 3.0.7...3.0.8

smart-doc-v3.0.7

17 Aug 14:48
52540a0
Compare
Choose a tag to compare

What's Changed

  • feat: Switching the publishing method to Central Portal. by @shalousun in #848
  • Update SolonRequestMappingHandler.java by @aqnghu in #849
  • feat: ✨ Add Grpc support by @linwumingshi in #851
  • feat: ✨ Add WebSocket html, ascii doc support by @linwumingshi in #855
  • feat: prevent user submitting blank issues by @shalousun in #861
  • feat: disable blank issue creation by @shalousun in #862
  • Feature/request part by @linwumingshi in #864
  • fix: 🐛 Fix the issue where the generated interface documentation lacks descriptive information when using Dubbo RPC or @javadoc tags and overriding a parent class or interface without Javadoc comments. by @linwumingshi in #866
  • feat: 📝 update issue template And Update PR CI GitHub Actions workflow by @linwumingshi in #868
  • feat: 📝 update issue template by @linwumingshi in #871
  • feat: ✨ Add support for Map with enum type keys by @linwumingshi in #870
  • feat: ✨ Add support for @JsonView by @linwumingshi in #875
  • Grant execute permissions for protoc-gen-doc on Linux/Mac OS by @linwumingshi in #879
  • chore(deps): bump io.spring.javaformat:spring-javaformat-maven-plugin from 0.0.42 to 0.0.43 by @linwumingshi in #880
  • chore(deps): bump org.eclipse.jgit:org.eclipse.jgit from 5.13.2.202306221912-r to 5.13.3.202401111512-r by @dependabot in #782
  • feat(github-actions): set up weekly dependency updates by @linwumingshi in #883
  • chore(deps): bump org.slf4j:slf4j-api from 2.0.13 to 2.0.16 by @dependabot in #885
  • chore(deps): bump com.ibeetl:beetl from 3.16.2.RELEASE to 3.17.0.RELEASE by @dependabot in #886
  • chore(deps): bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.4 to 3.2.5 by @dependabot in #887
  • chore(deps-dev): bump org.junit.jupiter:junit-jupiter from 5.10.2 to 5.11.0 by @dependabot in #888
  • Added support for message and response parameters by @linwumingshi in #882
  • fix(rpc): Fix the ClassCastException issue that occurs during the construction of the RPC. #889 by @xiangganLuo in #890
  • enhance IJavadocDocTemplate with generics for method documentation by @linwumingshi in #891
  • Ensure Java format validation reports failure explicitly by @linwumingshi in #892

New Contributors

Full Changelog: 3.0.6...3.0.7

smart-doc-v3.0.6

05 Jul 15:28
15a60a3
Compare
Choose a tag to compare

What's Changed

  • deps: bump gson,slf4j-api,beetl,common-util to latest version by @shalousun in #812
  • fix: rest api sort error by @shalousun in #813
  • fix: Tree structure parsing bug by @shalousun in #814
  • deps: Bump JQuery to 3.7.1, Highlight.js to v11.9.0 by @shalousun in #815
  • fix: Fix the issue where the generated OpenAPI is not sorted according to the specified order. by @shalousun in #817
  • optimised: Optimise the duplicate code in the template builders by @shalousun in #818
  • fix: 🐛 add jakarta validation group to fix issue #819 by @linwumingshi in #820
  • Fix/jsr303 required field bug by @linwumingshi in #823
  • fix: It is suspected that the curl request generated under a single file cannot obtain the header correctly. Currently, the debug execution is successful under multiple files, and the curl command generated by copying cannot be requested. Changing to double quotation marks is normal by @Hans-Wu-cn in #827
  • fix: 🐛 Prevent EntryAnnotation from being inherited from parent classes and interfaces by @linwumingshi in #825
  • fix: 🐛 Fix display issues for Instant and EnumSet<?> types by @linwumingshi in #829
  • fix: Generate OpenAPI Paths Object tags do not match by @Itswag in #831
  • Feature/jsonformat and json serialize by @linwumingshi in #834
  • refactor: ♻️ Add HttpStatusEnum and enhance HttpStatusUtil by @linwumingshi in #837
  • fix(openapi): 🐛 support @jsonformat(shape = JsonFormat.Shape.NUMBER) annotation for enum types example by @linwumingshi in #836
  • fix: 🐛 ensure non-null collections for API schema properties by @linwumingshi in #841
  • refactor(build-template): ♻️ utilize ServiceLoader for dynamic loading by @linwumingshi in #839
  • docs: 📝 update Chinese documentation links by @linwumingshi in #842

New Contributors

Full Changelog: 3.0.5...3.0.6

smart-doc-v3.0.5

09 Jun 08:53
b8afb7d
Compare
Choose a tag to compare

What's Changed

  • If comment is empty, replace it with "undefined" by @jingxiang in #788
  • fix #789 NPE in JsonBuildHelper by @muyuanjin in #790
  • feat: Optimize the settings for ExampleBody to remove duplicated code. by @shalousun in #794
  • Support @javadoc tag for normal service. by @tuichenchuxin in #797
  • fix: Javadoc method definition add modifier. by @shalousun in #801
  • Optimize: Optimize the repetitive code in RPC and Javadoc document gereration template. by @shalousun in #802
  • fix: Fix the bug where enum type parameter comments are missing in the query. by @shalousun in #803
  • fix: Generic replacement error causing parsing bug. by @shalousun in #805
  • fix: Fix the bug where the sequence number sorting is incorrect when using the @order tag. by @shalousun in #806
  • feat: Optimize and refactor constant definitions. by @shalousun in #807
  • fix: Fix the issue where exported documents display incorrectly in tools like Postman when the content-type is form-data and urlencoded. by @shalousun in #808
  • feat: Optimize the document generation template return interface definition to support future API interface error configuration additions. by @shalousun in #809
  • feat: Supports generating descriptions for OpenAPI HTTP error statuses like 404, 500, etc. by @shalousun in #810
  • release: 3.0.5. by @shalousun in #811

New Contributors

Full Changelog: 3.0.4...3.0.5

smart-doc-v3.0.4

13 May 01:57
5526a06
Compare
Choose a tag to compare

What's Changed

  • fix : Result<<Page>> fields explain failed by @netdied in #777
  • feat: Support for JMeter Prometheus Listener by @shalousun in #779
  • feat: Optimize the names generated by JMeter scripts by @shalousun in #781
  • feat: Optimize JMeter config by @shalousun in #783
  • feat: Optimize Duplicate Code by @shalousun in #784
  • Import enum class, comment @see after writing only the class name can not find the corresponding enum by @suihe1 in #785

New Contributors

Full Changelog: 3.0.3...3.0.4

smart-doc-v3.0.3

31 Mar 15:04
b3bee2e
Compare
Choose a tag to compare

What's Changed

  • fixed #747: When exporting the dataDictionaries dictionary, add a Name field. by @baboy in #748
  • feat #749: add new tag @extension to support openapi extensions. by @baboy in #750
  • feat: ✨ Add WebSocket support and update license validity period by @linwumingshi in #752
  • fixed #746: add separator for Enum values by @baboy in #754
  • feat: Optimizing the extraction of JSR validation information by @shalousun in #755
  • fixed #758 fixed #749: add extension in parameters to support openapi… by @baboy in #759
  • chore: ignore Eclipse configuration files by @leeyazhou in #762
  • fix: 🐛 fix the Generics typeName or returnType error by @linwumingshi in #761
  • Solon has discarded PathVar and replaced it with Path by @Hans-Wu-cn in #765
  • optimised: Optimise the error prompt for incorrect Javadoc tag usage. by @shalousun in #767
  • Fix non interface documentation in the Solon framework by @Hans-Wu-cn in #771
  • update: Fix the issue of extra double quotes in null parameter values. by @shalousun in #772
  • feat: Support for multiple-level interface inheritance in RPC. by @shalousun in #773
  • feat: after adding custom annotations to parameters, ignore the collection parameter check. by @shalousun in #774
  • feat: ignore the collection parameter check. by @shalousun in #775

New Contributors

Full Changelog: 3.0.2...3.0.3

smart-doc-v3.0.2

27 Feb 01:44
d46e10c
Compare
Choose a tag to compare

What's Changed

  • Fix the error in setting the default value of the framework configuration when pushing rpc documentation to Torna. by @shalousun in #691
  • update: README_CN.md and README.md by @shalousun in #692
  • fix: fix interface url rules in search js by @chenqi146 in #693
  • feat-When uploading Torna, batch uploading of documents is supported by @bugDesigner1 in #697
  • fix: fix mock escape(query, body, curl, example) by @chenqi146 in #700
  • Support for Java Record by @shalousun in #703
  • fix: error reporting information by @WingGao in #706
  • fix: fix the issue of Tonar push by @SteinsGate1097302 in #707
  • feat: don't create config file when the increment is false by @linwumingshi in #708
  • refactor: refactor word template style by @chenqi146 in #710
  • fix: 🐛 Fix a bug when creating a Word file: invalid entry compres… by @linwumingshi in #711
  • fix: 🐛 Fix the BUG in JMeter files caused by the presence of escape characters, resulting in an error when opening the file. by @linwumingshi in #713
  • feat: ✨ display parameters when using @JsonSerialize(using = ToStringSerializer.class) as strings by @linwumingshi in #715
  • refactor: ♻️ rename the class DocJavaField some attribute by @linwumingshi in #717
  • Fix: Fix openApi generated tags and paths that did not filter package… by @Mr-lijx in #718
  • fix: 🐛 Git initialization of a project reports a null pointer err… by @linwumingshi in #720
  • chore(deps): bump com.ibeetl:beetl from 3.15.7.RELEASE to 3.15.13.RELEASE by @dependabot in #721
  • feat: Ignore NoClassDefFoundError by @shalousun in #724
  • update CHANGELOG.md for 3.0.2 by @shalousun in #727
  • fix: Incorrect documentation example type when the return type is "void" by @LabelZhou in #726
  • Fix the bug that prevents parsing when using an inner enum class as a… by @shalousun in #728
  • Fix JAX-RS documentation generation bug. by @shalousun in #729
  • Optimize constant retrieval by @shalousun in #730
  • format code by @shalousun in #731
  • fix: 🐛 Bug fix for error when casting to string by @linwumingshi in #732
  • style(word): refactor word style by @chenqi146 in #733
  • Fix the Issue of Binding Collection Parameters in JAX-RS by @shalousun in #735
  • fix: 🐛 when @see an enum on a field that is not an enum itself,… by @linwumingshi in #734
  • feat: add class level package exclude filters by @chenqi146 in #736
  • refactor: ♻️ rename param type constants and format code by @linwumingshi in #738
  • fix(html): fix group and dict alias field is null by @chenqi146 in #737
  • add: request part annotation by @shalousun in #739
  • Add an explanation attribute for enumeration types in the OpenAPI specification. by @baboy in #741
  • feat: Add a divider line between interfaces in the Word template. by @chenqi146 in #742
  • release 3.0.2 by @shalousun in #743

New Contributors

Full Changelog: 3.0.1...3.0.2

smart-doc-v3.0.1

17 Dec 08:35
5a45421
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: 3.0.0...3.0.1

smart-doc-v3.0.0

19 Oct 01:43
ac47cf7
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: 2.7.7...3.0.0