# Openapi maven plugin
[![Maven Central](https://img.shields.io/maven-central/v/io.github.kbuntrock/openapi-maven-plugin.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/io.github.kbuntrock/openapi-maven-plugin)
[![CircleCI](https://circleci.com/gh/kbuntrock/openapi-maven-plugin/tree/dev.svg?style=shield)](https://circleci.com/gh/kbuntrock/openapi-maven-plugin/tree/dev)
![GitHub](https://img.shields.io/github/license/kbuntrock/openapi-maven-plugin?color=blue)
The openapi maven plugin analyse Rest controller java classes and generate the corresponding openapi 3.0.3 documentation. It supports Spring MVC, Javax RS and Jakarta RS annotations.
It is compatible from jdk8 to at least jdk17 (IT tests are run on jdk8, jdk11 and jdk17).
The plugin generate the documentation using the compiled classes + the source code of the project.
Doing this process during the building phase of a project has several advantages compared to other methods:
- the source code of the project can be parsed to extract javadoc comments and enrich the generated documentation. There is no need of a third party annotation library for the sole purpose of keeping comments available at runtime. Your code stay pure and you don't duplicate information.
- no extra dependency in your jar/war. No need to monitor another library for vulnerabilities.
- implementating interfaces or abstract classes is not a requirement. The documentation can be generated from a module referencing only interfaces; which will be later in the build chain implemented in one or several other modules.
- usually faster than launching an app / running the integration test phase
Numerous configuration options are available.
One can mention :
- possibility to generate several documentations with different configurations
- "white list" / "black list" mecanism on scanned classes / methods
- addition of infos not found in the code (security, licence, ...)
- defining a "loopback operation name", used by some code generation tools (see [here](https://loopback.io/doc/en/lb4/Decorators_openapi.html) and [here](https://github.com/cyclosproject/ng-openapi-gen) ).
...
Full documentation is located [here](https://kbuntrock.github.io/openapi-maven-plugin) and is available in english or french.
没有合适的资源?快使用搜索试试~ 我知道了~
为Springmvc或JaxRS JakartaRS项目生成openapi文档.zip
共400个文件
java:252个
yml:61个
xml:20个
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 92 浏览量
2023-11-02
10:17:15
上传
评论
收藏 570KB ZIP 举报
温馨提示
为Springmvc或JaxRS JakartaRS项目生成openapi文档.zip
资源推荐
资源详情
资源评论
收起资源包目录
为Springmvc或JaxRS JakartaRS项目生成openapi文档.zip (400个子文件)
.browserslistrc 600B
app.component.css 5KB
styles.css 80B
.editorconfig 274B
.gitattributes 238B
.gitignore 599B
.gitignore 548B
.gitkeep 0B
requestBuilder.handlebars 11KB
module.handlebars 1KB
service.handlebars 964B
baseService.handlebars 812B
operationResponse.handlebars 774B
index.handlebars 528B
operationBody.handlebars 470B
handleResponse.handlebars 411B
operationParameters.handlebars 396B
configuration.handlebars 355B
model.handlebars 286B
response.handlebars 273B
object.handlebars 225B
modelIndex.handlebars 129B
enum.handlebars 105B
operationPath.handlebars 94B
serviceIndex.handlebars 85B
simple.handlebars 44B
app.component.html 4KB
index.html 300B
favicon.ico 948B
SpringClassAnalyserTest.java 32KB
YamlWriter.java 16KB
DataObject.java 13KB
JakartaRsReader.java 12KB
Schema.java 12KB
JavaxRsReader.java 12KB
DocumentationMojo.java 10KB
JavadocParser.java 10KB
SpringMvcReader.java 9KB
CommonApiConfiguration.java 8KB
JavadocParserTest.java 7KB
UserControllerImpl.java 7KB
ClassGenericityResolver.java 6KB
ClassDocumentation.java 6KB
JavaClassAnalyser.java 6KB
TagLibrary.java 6KB
ApiConfiguration.java 5KB
AccountController.java 5KB
ApiResourceScanner.java 5KB
JaxrsClassAnalyserTest.java 4KB
BasicIT.java 4KB
AstractLibraryReader.java 4KB
AllLibraryClassAnalyser.java 4KB
JavaSourceAnalysisTest.java 4KB
AdminUserDto.java 3KB
UserDto.java 3KB
UserDto.java 3KB
UserDto.java 3KB
UserDto.java 3KB
JavadocWrapper.java 3KB
BasicIT.java 3KB
AbstractTest.java 3KB
UserDto.java 3KB
UserDto.java 3KB
OperationIdHelper.java 2KB
OpenApiDataType.java 2KB
ReflectionsUtils.java 2KB
Library.java 2KB
Operation.java 2KB
AccountDto.java 2KB
Info.java 2KB
OperationType.java 2KB
JsonConfigurationParserUtils.java 2KB
Specification.java 2KB
Property.java 2KB
NumberDto.java 2KB
MapPlaytestControllerImpl.java 2KB
Content.java 2KB
Endpoint.java 2KB
Operation.java 2KB
ReflectionUtilsTest.java 2KB
FileUploadController.java 2KB
GenericityTestTwo.java 2KB
EnumPlaytestControllerImpl.java 2KB
UserController.java 1KB
Tag.java 1KB
TimeControllerImpl.java 1KB
OperationIdHelperTest.java 1KB
AccountControllerImpl.java 1KB
ChildClassOne.java 1KB
UserGroupDto.java 1KB
JavadocConfiguration.java 1KB
CommentType.java 1KB
FileUploadController.java 1KB
FileUploadControllerImpl.java 1KB
RecordDto.java 1KB
UserGroupDto.java 1KB
GenericityTestOne.java 1KB
EnumPlaytestController.java 1KB
InterfaceDto.java 1KB
ParameterizedTypeImpl.java 1012B
共 400 条
- 1
- 2
- 3
- 4
资源评论
GZM888888
- 粉丝: 176
- 资源: 2945
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功