tangcent / easy-yapi

Generate API document to yapi
https://easyyapi.com
GNU Affero General Public License v3.0
425 stars 141 forks source link

feat: add rules `param.name`, `param.type` #1128

Closed tangcent closed 2 months ago

tangcent commented 2 months ago

closes #1126

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 63.75000% with 29 lines in your changes are missing coverage. Please review.

Project coverage is 62.073%. Comparing base (0cb6bb6) to head (489cd80). Report is 1 commits behind head on master.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128/graphs/tree.svg?width=650&height=150&src=pr&token=J6RUGI54XV&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent)](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent) ```diff @@ Coverage Diff @@ ## master #1128 +/- ## =============================================== + Coverage 61.985% 62.073% +0.088% Complexity 2289 2289 =============================================== Files 250 250 Lines 12119 12126 +7 Branches 2997 2996 -1 =============================================== + Hits 7512 7527 +15 + Misses 3000 2994 -6 + Partials 1607 1605 -2 ``` | [Flag](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent) | `62.073% <63.750%> (+0.088%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent) | Coverage Δ | | |---|---|---| | [...idea/plugin/api/export/core/ClassExportRuleKeys.kt](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?src=pr&el=tree&filepath=idea-plugin%2Fsrc%2Fmain%2Fkotlin%2Fcom%2Fitangcent%2Fidea%2Fplugin%2Fapi%2Fexport%2Fcore%2FClassExportRuleKeys.kt&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent#diff-aWRlYS1wbHVnaW4vc3JjL21haW4va290bGluL2NvbS9pdGFuZ2NlbnQvaWRlYS9wbHVnaW4vYXBpL2V4cG9ydC9jb3JlL0NsYXNzRXhwb3J0UnVsZUtleXMua3Q=) | `100.000% <100.000%> (ø)` | | | [...gcent/idea/plugin/api/export/core/ExportContext.kt](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?src=pr&el=tree&filepath=idea-plugin%2Fsrc%2Fmain%2Fkotlin%2Fcom%2Fitangcent%2Fidea%2Fplugin%2Fapi%2Fexport%2Fcore%2FExportContext.kt&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent#diff-aWRlYS1wbHVnaW4vc3JjL21haW4va290bGluL2NvbS9pdGFuZ2NlbnQvaWRlYS9wbHVnaW4vYXBpL2V4cG9ydC9jb3JlL0V4cG9ydENvbnRleHQua3Q=) | `94.595% <100.000%> (+11.261%)` | :arrow_up: | | [...ugin/api/export/jaxrs/JAXRSRequestClassExporter.kt](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?src=pr&el=tree&filepath=idea-plugin%2Fsrc%2Fmain%2Fkotlin%2Fcom%2Fitangcent%2Fidea%2Fplugin%2Fapi%2Fexport%2Fjaxrs%2FJAXRSRequestClassExporter.kt&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent#diff-aWRlYS1wbHVnaW4vc3JjL21haW4va290bGluL2NvbS9pdGFuZ2NlbnQvaWRlYS9wbHVnaW4vYXBpL2V4cG9ydC9qYXhycy9KQVhSU1JlcXVlc3RDbGFzc0V4cG9ydGVyLmt0) | `68.041% <100.000%> (ø)` | | | [...ugin/api/export/spring/ActuatorEndpointExporter.kt](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?src=pr&el=tree&filepath=idea-plugin%2Fsrc%2Fmain%2Fkotlin%2Fcom%2Fitangcent%2Fidea%2Fplugin%2Fapi%2Fexport%2Fspring%2FActuatorEndpointExporter.kt&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent#diff-aWRlYS1wbHVnaW4vc3JjL21haW4va290bGluL2NvbS9pdGFuZ2NlbnQvaWRlYS9wbHVnaW4vYXBpL2V4cG9ydC9zcHJpbmcvQWN0dWF0b3JFbmRwb2ludEV4cG9ydGVyLmt0) | `82.759% <ø> (ø)` | | | [...ugin/api/export/feign/FeignRequestClassExporter.kt](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?src=pr&el=tree&filepath=idea-plugin%2Fsrc%2Fmain%2Fkotlin%2Fcom%2Fitangcent%2Fidea%2Fplugin%2Fapi%2Fexport%2Ffeign%2FFeignRequestClassExporter.kt&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent#diff-aWRlYS1wbHVnaW4vc3JjL21haW4va290bGluL2NvbS9pdGFuZ2NlbnQvaWRlYS9wbHVnaW4vYXBpL2V4cG9ydC9mZWlnbi9GZWlnblJlcXVlc3RDbGFzc0V4cG9ydGVyLmt0) | `68.235% <0.000%> (ø)` | | | [...dea/plugin/api/export/core/RequestClassExporter.kt](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?src=pr&el=tree&filepath=idea-plugin%2Fsrc%2Fmain%2Fkotlin%2Fcom%2Fitangcent%2Fidea%2Fplugin%2Fapi%2Fexport%2Fcore%2FRequestClassExporter.kt&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent#diff-aWRlYS1wbHVnaW4vc3JjL21haW4va290bGluL2NvbS9pdGFuZ2NlbnQvaWRlYS9wbHVnaW4vYXBpL2V4cG9ydC9jb3JlL1JlcXVlc3RDbGFzc0V4cG9ydGVyLmt0) | `60.771% <89.286%> (+1.274%)` | :arrow_up: | | [...in/api/export/spring/SpringRequestClassExporter.kt](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?src=pr&el=tree&filepath=idea-plugin%2Fsrc%2Fmain%2Fkotlin%2Fcom%2Fitangcent%2Fidea%2Fplugin%2Fapi%2Fexport%2Fspring%2FSpringRequestClassExporter.kt&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent#diff-aWRlYS1wbHVnaW4vc3JjL21haW4va290bGluL2NvbS9pdGFuZ2NlbnQvaWRlYS9wbHVnaW4vYXBpL2V4cG9ydC9zcHJpbmcvU3ByaW5nUmVxdWVzdENsYXNzRXhwb3J0ZXIua3Q=) | `34.074% <37.500%> (+0.370%)` | :arrow_up: | | [.../api/export/generic/GenericRequestClassExporter.kt](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?src=pr&el=tree&filepath=idea-plugin%2Fsrc%2Fmain%2Fkotlin%2Fcom%2Fitangcent%2Fidea%2Fplugin%2Fapi%2Fexport%2Fgeneric%2FGenericRequestClassExporter.kt&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent#diff-aWRlYS1wbHVnaW4vc3JjL21haW4va290bGluL2NvbS9pdGFuZ2NlbnQvaWRlYS9wbHVnaW4vYXBpL2V4cG9ydC9nZW5lcmljL0dlbmVyaWNSZXF1ZXN0Q2xhc3NFeHBvcnRlci5rdA==) | `27.673% <11.765%> (-0.353%)` | :arrow_down: | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent). Last update [0cb6bb6...489cd80](https://app.codecov.io/gh/tangcent/easy-yapi/pull/1128?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tangcent).