{"id":24975551,"url":"https://github.com/springdoc/springdoc-openapi-maven-plugin","last_synced_at":"2025-04-09T11:12:09.875Z","repository":{"id":35461588,"uuid":"207024553","full_name":"springdoc/springdoc-openapi-maven-plugin","owner":"springdoc","description":"Library for OpenAPI 3 with spring-boot","archived":false,"fork":false,"pushed_at":"2024-02-01T16:07:00.000Z","size":286,"stargazers_count":129,"open_issues_count":7,"forks_count":34,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-13T21:47:59.739Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://springdoc.org","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/springdoc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.adoc","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"open_collective":"springdoc-openapi"}},"created_at":"2019-09-07T20:52:06.000Z","updated_at":"2024-04-10T13:49:04.000Z","dependencies_parsed_at":"2024-03-18T22:03:40.241Z","dependency_job_id":"718b27d1-cd24-48b9-a47b-3d8f2b21a1d4","html_url":"https://github.com/springdoc/springdoc-openapi-maven-plugin","commit_stats":{"total_commits":96,"total_committers":19,"mean_commits":5.052631578947368,"dds":0.6458333333333333,"last_synced_commit":"945144ed04a3e84f2e32675436c8dae9ec4fc760"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springdoc%2Fspringdoc-openapi-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springdoc%2Fspringdoc-openapi-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springdoc%2Fspringdoc-openapi-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springdoc%2Fspringdoc-openapi-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/springdoc","download_url":"https://codeload.github.com/springdoc/springdoc-openapi-maven-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248027411,"owners_count":21035594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-03T21:00:43.400Z","updated_at":"2025-04-09T11:12:09.853Z","avatar_url":"https://github.com/springdoc.png","language":"Java","readme":"[![Build Status](https://ci-cd.springdoc.org:8443/buildStatus/icon?job=springdoc-openapi-maven-plugin-release)](https://ci-cd.springdoc.org:8443/view/springdoc-openapi/job/springdoc-openapi-maven-plugin-release/)\n\n## **Introduction to springdoc-openapi-maven-plugin**\n\nThe aim of springdoc-openapi-maven-plugin is to generate json and yaml OpenAPI description during runtime. If you want to get swagger definitions properly, the application should completely running as locally.\nThe plugin works during integration-tests phase, and generate the OpenAPI description. \nThe plugin works in conjunction with spring-boot-maven plugin. \n\nYou can test it during the integration tests phase using the maven command:\n\n```shell\nmvn verify\n```\n\nIn order to use this functionality, you need to add the plugin declaration on the plugins section of your pom.xml:\n\n```xml\n\u003cplugins\u003e\n  \u003cplugin\u003e\n   \u003cgroupId\u003eorg.springframework.boot\u003c/groupId\u003e\n   \u003cartifactId\u003espring-boot-maven-plugin\u003c/artifactId\u003e\n   \u003cversion\u003e2.3.4.RELEASE\u003c/version\u003e\n   \u003cconfiguration\u003e\n      \u003cjvmArguments\u003e-Dspring.application.admin.enabled=true\u003c/jvmArguments\u003e\n   \u003c/configuration\u003e\n   \u003cexecutions\u003e\n    \u003cexecution\u003e\n     \u003cid\u003epre-integration-test\u003c/id\u003e\n     \u003cgoals\u003e\n      \u003cgoal\u003estart\u003c/goal\u003e\n     \u003c/goals\u003e\n    \u003c/execution\u003e\n    \u003cexecution\u003e\n     \u003cid\u003epost-integration-test\u003c/id\u003e\n     \u003cgoals\u003e\n      \u003cgoal\u003estop\u003c/goal\u003e\n     \u003c/goals\u003e\n    \u003c/execution\u003e\n   \u003c/executions\u003e\n  \u003c/plugin\u003e\n  \u003cplugin\u003e\n   \u003cgroupId\u003eorg.springdoc\u003c/groupId\u003e\n   \u003cartifactId\u003espringdoc-openapi-maven-plugin\u003c/artifactId\u003e\n   \u003cversion\u003e1.1\u003c/version\u003e\n   \u003cexecutions\u003e\n    \u003cexecution\u003e\n     \u003cid\u003eintegration-test\u003c/id\u003e\n     \u003cgoals\u003e\n      \u003cgoal\u003egenerate\u003c/goal\u003e\n     \u003c/goals\u003e\n    \u003c/execution\u003e\n   \u003c/executions\u003e\n  \u003c/plugin\u003e\n\u003c/plugins\u003e\n```\n\t\t\t\n## **Custom settings of the springdoc-openapi-maven-plugin**\n\nIt possible to customise the following plugin properties:\n*   attachArtifact: install / deploy the api doc to the repository\n    * The default value is: false\n*   apiDocsUrl: The local url of your (json or yaml). \n    * The default value is: http://localhost:8080/v3/api-docs\n*  outputDir: The output directory, where to generate the OpenAPI description. The directory name shouldn't start with \"/\".\n    * The default value is: ${project.build.directory}\n*   outputFileName: The file name that contains the OpenAPI description.  \n    * The default value is: openapi.json\n*   skip: Skip execution if set to true.\n    * The default value is: false\n*   headers: List of headers to send in request\n    * The default value is empty\n\n```xml\n\u003cplugin\u003e\n \u003cgroupId\u003eorg.springdoc\u003c/groupId\u003e\n \u003cartifactId\u003espringdoc-openapi-maven-plugin\u003c/artifactId\u003e\n \u003cversion\u003e1.1\u003c/version\u003e\n \u003cexecutions\u003e\n  \u003cexecution\u003e\n   \u003cid\u003eintegration-test\u003c/id\u003e\n   \u003cgoals\u003e\n    \u003cgoal\u003egenerate\u003c/goal\u003e\n   \u003c/goals\u003e\n  \u003c/execution\u003e\n \u003c/executions\u003e\n \u003cconfiguration\u003e\n  \u003capiDocsUrl\u003ehttp://localhost:8080/v3/api-docs\u003c/apiDocsUrl\u003e\n  \u003coutputFileName\u003eopenapi.json\u003c/outputFileName\u003e\n  \u003coutputDir\u003ehome/springdoc/maven-output\u003c/outputDir\u003e\n  \u003cskip\u003efalse\u003c/skip\u003e\n  \u003cheaders\u003e\n    \u003cheader1key\u003eheader1value\u003c/header1key\u003e\n    \u003cheader2key\u003eheader2value\u003c/header2key\u003e\n  \u003c/headers\u003e\n \u003c/configuration\u003e\n\u003c/plugin\u003e\n```\n\n# **Thank you for the support**\n\n* Thanks a lot [JetBrains](https://www.jetbrains.com/?from=springdoc-openapi) for supporting springdoc-openapi project.\n\n![JenBrains logo](https://springdoc.org/img/jetbrains.svg)\n","funding_links":["https://opencollective.com/springdoc-openapi"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringdoc%2Fspringdoc-openapi-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspringdoc%2Fspringdoc-openapi-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringdoc%2Fspringdoc-openapi-maven-plugin/lists"}