{"id":23722386,"url":"https://github.com/springfox/springfox-grails-integration","last_synced_at":"2026-02-28T11:05:51.134Z","repository":{"id":15448504,"uuid":"78167902","full_name":"springfox/springfox-grails-integration","owner":"springfox","description":"SpringFox integration with Grails 3.x","archived":false,"fork":false,"pushed_at":"2022-05-18T17:19:06.000Z","size":256,"stargazers_count":19,"open_issues_count":30,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-03T23:43:03.438Z","etag":null,"topics":["grails","groovy","oai","spring","springfox","swagger"],"latest_commit_sha":null,"homepage":"","language":"Groovy","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/springfox.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-06T02:51:08.000Z","updated_at":"2023-12-14T19:44:38.000Z","dependencies_parsed_at":"2022-08-31T17:02:26.512Z","dependency_job_id":null,"html_url":"https://github.com/springfox/springfox-grails-integration","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/springfox/springfox-grails-integration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox-grails-integration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox-grails-integration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox-grails-integration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox-grails-integration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/springfox","download_url":"https://codeload.github.com/springfox/springfox-grails-integration/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springfox%2Fspringfox-grails-integration/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29931255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-28T09:58:13.507Z","status":"ssl_error","status_checked_at":"2026-02-28T09:57:57.047Z","response_time":90,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["grails","groovy","oai","spring","springfox","swagger"],"created_at":"2024-12-30T23:51:49.081Z","updated_at":"2026-02-28T11:05:51.116Z","avatar_url":"https://github.com/springfox.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"= SpringFox Grails Integration\n\nimage:https://api.bintray.com/packages/springfox/maven-repo/springfox-grails-integration/images/download.svg[\"Download\", link=\"https://bintray.com/springfox/maven-repo/springfox-grails-integration/_latestVersion\"]\nimage:https://circleci.com/gh/springfox/springfox-grails-integration.svg?style=svg[\"CircleCI\", link=\"https://circleci.com/gh/springfox/springfox-grails-integration\"]\nimage:https://codecov.io/gh/springfox/springfox-grails-integration/branch/master/graph/badge.svg[\"codecov\",link=\"https://codecov.io/gh/springfox/springfox-grails-integration\"]\nimage:https://api.codacy.com/project/badge/Grade/77fbd793eb06447d9f1bf47eb8cdad8b[\"Codacy code quality\", link=\"https://www.codacy.com/app/dilip-krishnan-github/springfox-grails-integration?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=springfox/springfox-grails-integration\u0026utm_campaign=Badge_Grade\"]\nimage:https://app.fossa.io/api/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox-grails-integration.svg?type=shield[\"FOSSA Status\", link=\"https://app.fossa.io/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox-grails-integration?ref=badge_shield\"]\n\nSpringFox Grails integration library that produces grails specific documentation.\n\n== Development Environment\n\n=== IDE setup \n\n==== IntelliJ IDEA\n\n- File \u003e\u003e open \u003e\u003e build.gradle\n- Make sure to check the 'use the default gradle wrapper' option.\n- First time build\n\n```bash\n./gradlew cleanIdea idea\n\n```\n\n=== Build\n\n- To get more output from any gradle commands/tasks append a `-i` (info) or `-d` (debug) e.g.\n```bash\n./gradlew clean build -i\n\n```\n- To publish to local maven repository\n```bash\n./gradlew clean build publishToMavenLocal -i\n\n```\n\n== Getting Started\n\n:releaseVersion: 1.0.0\n:snapshotVersion: 1.0.1-SNAPSHOT\n:springfoxVersion: 2.7.0\n:springfoxRfc6570Version: 1.0.0\n\nThe SpringFox Grails integration library depends on http://springfox.github.io/springfox/docs/current/[Springfox]\n\nimage:https://api.bintray.com/packages/springfox/maven-repo/springfox/images/download.svg[\"Download\", link=\"https://bintray.com/springfox/maven-repo/springfox/_latestVersion\"]\n\n\n== Dependencies\nThe Springfox libraries are hosted on https://bintray.com/springfox/maven-repo/springfox/view[bintray] and jcenter.\nThe artifacts can be viewed accessed at the following locations:\n\n* Release:\n   ** https://jcenter.bintray.com/io/springfox/\n   ** http://jcenter.bintray.com/io/springfox/\n* Snapshot\n ** http://oss.jfrog.org/simple/oss-snapshot-local/io/springfox/\n ** http://oss.jfrog.org/oss-snapshot-local/io/springfox/\n\nSpringFox has multiple modules and the dependencies will vary depending on the desired API specification standard.\nBelow outlines how to include the springfox-swagger2 module which produces Swagger 2.0 API documentation.\n\nTIP: Refer the main documentation on how to http://springfox.github.io/springfox/docs/current/#swagger-ui[include springfox bundled swagger-ui] dependencies\n\nNOTE: Please refer the main documentation on how to http://springfox.github.io/springfox/docs/current/#dependencies[include the springfox-swagger2 dependencies]\nwhich are required for this integration library to work.\n\n=== Release\n[source,groovy]\n[subs=\"verbatim,attributes\"]\n----\nrepositories {\n  jcenter()\n}\n\ndependencies {\n    compile \"io.springfox.grails:springfox-grails:{releaseVersion}\" //\u003c1\u003e\n}\n----\n\n=== Snapshot\n\n[source,groovy]\n[subs=\"verbatim,attributes\"]\n----\nrepositories {\n   maven { url 'http://oss.jfrog.org/artifactory/oss-snapshot-local/' }\n}\n\ndependencies {\n    compile \"io.springfox.grails:springfox-grails:{snapshotVersion}\" //\u003c1\u003e\n}\n----\n\n== Configuration\n\nIn your Application (GrailsAutoConfiguration) startup entry-point follow the steps below\n\n[source,groovy]\n[subs=\"verbatim,attributes\"]\n----\n\n// 1. Enable SpringFox on your project\n@EnableSwagger2\n// 2. Import the springfox grails integration configuration\n@Import([springfox.documentation.grails.SpringfoxGrailsIntegrationConfiguration])\nclass Application extends GrailsAutoConfiguration {\n  static void main(String[] args) {\n    GrailsApp.run(Application, args)\n  }\n\n  // 3. **Optionally** define a custom docket or omit this step to use the default\n  // For grails it is preferrable to use use the following settings.\n  @Bean\n  Docket api() {\n    new Docket(DocumentationType.SWAGGER_2)\n        .ignoredParameterTypes(MetaClass)\n        .select()\n        .paths(not(ant(\"/error\")))\n        .build()\n  }\n\n   // 4. **Optionally** in the absense of asset pipeline configure the swagger-ui webjar to serve the scaffolded\n   swagger UI\n   @Bean\n   static WebMvcConfigurerAdapter webConfigurer() {\n     new WebMvcConfigurerAdapter() {\n       @Override\n       void addResourceHandlers(ResourceHandlerRegistry registry) {\n         if (!registry.hasMappingForPattern(\"/webjars/**\")) {\n           registry\n               .addResourceHandler(\"/webjars/**\")\n               .addResourceLocations(\"classpath:/META-INF/resources/webjars/\")\n         }\n         if (!registry.hasMappingForPattern(\"/swagger-ui.html\")) {\n           registry\n               .addResourceHandler(\"/swagger-ui.html\")\n               .addResourceLocations(\"classpath:/META-INF/resources/swagger-ui.html\")\n         }\n       }\n      }\n    }\n}\n----\n\n== Swagger UI integration\n\nIMPORTANT: In order to use the bundled swagger UI as explained in ___step 4___ above. The following library needs to be\nincluded in the `build.gradle`\n\n[source,groovy]\n[subs=\"verbatim,attributes\"]\n----\nrepositories {\n  jcenter()\n}\n\ndependencies {\n    compile \"compile \"io.springfox:springfox-swagger-ui:{springfoxVersion}\" //\u003c1\u003e\n}\n----\n\nNOTE: The latest released version is image:https://api.bintray.com/packages/springfox/maven-repo/springfox/images/download.svg[\"Springfox Version\",\nlink=\"https://bintray.com/springfox/maven-repo/springfox/_latestVersion\"]\n\n== Extensibility\nThe library comes with intelligent defaults imeplemented by `DefaultGrailsAlternateTypeRuleConvention`. However the\ndefaults can be tweaked using one of these extensibility mechanisms. The following classes can be implemented and\nregistered as a bean to augment default behavior.\n\n- AlternateTypeRuleConvention - for adding custom conventions for replacing grails types\n- GrailsPropertySelector - for overriding the selection of grails properties by the default convention\n- GrailsPropertyTransformer - for overriding the transformer of the grails property\n- GeneratedClassNamingStrategy - for naming the generated class mixins\n\n\n== Demo application\n\nThe demo application is available in https://github.com/springfox/springfox-grails-demo[this repository]. You can\nsee a live demo running or https://immense-escarpment-17128.herokuapp.com/swagger-ui.html[heroku here].\n\n== Troubleshooting\n\nIf you get an exception when you try to run your app, this might be because of the chosen profile for your application.\nIf you use the `rest-api` profile, everything should be fine, but if you've chosen the `web` profile, it is likely that\nyou have to add something like this.\n\n    grails.serverURL: http://localhost:8080\n    \nto your `application.yml` for the plugin to render absolute links.\n\n\n\n## License\nimage:https://app.fossa.io/api/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox-grails-integration.svg?type=large[\"FOSSA Status\", link=\"https://app.fossa.io/projects/git%2Bgithub.com%2Fspringfox%2Fspringfox-grails-integration?ref=badge_large\"]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringfox%2Fspringfox-grails-integration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspringfox%2Fspringfox-grails-integration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringfox%2Fspringfox-grails-integration/lists"}