{"id":26585330,"url":"https://github.com/funkyfangs/springdoc-customizer","last_synced_at":"2026-04-18T00:01:46.795Z","repository":{"id":157769424,"uuid":"620070003","full_name":"funkyFangs/springdoc-customizer","owner":"funkyFangs","description":"A module for fine-grain customization of SpringDoc REST Services","archived":false,"fork":false,"pushed_at":"2023-06-27T18:35:50.000Z","size":164,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-03-23T10:42:21.123Z","etag":null,"topics":["openapi","rest-api","springdoc","swagger"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/funkyFangs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2023-03-28T01:06:33.000Z","updated_at":"2023-04-28T10:07:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"20a93865-4769-44e9-a3ed-7b96ce8db42f","html_url":"https://github.com/funkyFangs/springdoc-customizer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/funkyFangs/springdoc-customizer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkyFangs%2Fspringdoc-customizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkyFangs%2Fspringdoc-customizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkyFangs%2Fspringdoc-customizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkyFangs%2Fspringdoc-customizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/funkyFangs","download_url":"https://codeload.github.com/funkyFangs/springdoc-customizer/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkyFangs%2Fspringdoc-customizer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31950891,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-17T17:29:20.459Z","status":"ssl_error","status_checked_at":"2026-04-17T17:28:47.801Z","response_time":62,"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":["openapi","rest-api","springdoc","swagger"],"created_at":"2025-03-23T10:36:38.008Z","updated_at":"2026-04-18T00:01:46.787Z","avatar_url":"https://github.com/funkyFangs.png","language":"Java","readme":"# springdoc-customizer\nA module for fine-grain customization of SpringDoc REST Services\n\n## About\n[springdoc-openapi](https://github.com/springdoc) provides the ability to generate OpenAPI specifications from Spring Boot REST services and offers\nfeatures for customization. The goal of this project is to extend these customization features to allow Spring Boot services to leverage helpful\nfeatures, such as serialized example injection or version customization.\n\nThis project supports Spring Boot's autoconfiguration and does not need much configuration out of the box.\n\n## Features\n### Examples\nExamples in OpenAPI are an incredibly important feature, especially for complex endpoints. However, in Swagger's annotations, examples can only be stored as literal strings; this creates several problems with defining examples as a result.\nLiteral strings cannot enforce the accuracy of the JSON values inside, and writing raw JSON without explicit type support can be tedious. Additionally, as a class model changes, example strings can become out of date and require additional maintenance.\n\nWith springdoc-customizer, we can forego these issues by declaring constant fields annotated with `@ExampleDetails`. By doing this, you can ensure your examples are both aligned with your class model as well as valid based on the validation annotations (such as Jakarta's `@NonNull` annotation).\n\nHere is an example of this annotation in use.\n\n```java\n@ExampleDetails(name = \"My Example\",\n        summary = \"An example of mine\",\n        description = \"This is a custom example of mine. It demonstrates the usage of the @ExampleDetails annotation.\",\n        targets = @ExampleTarget(controller = MyController.class,\n                methods = @ExampleMethod(name = \"create\", types = @ExampleType(REQUEST))))\npublic static final Resource RESOURCE = Resource.builder()\n        .stringField(\"String\")\n        .intField(99)\n        .build();\n```\n\nThis tells springdoc-customizer to inject the value of this field into the OpenAPI specification under the request path for the `create` method in `MyController`; this will in turn serialize this example into the following JSON.\n\n```json\n{\n  \"stringField\": \"String\",\n  \"intField\": 99\n}\n```\n\nLet's assume that `intField` is annotated with `@Size(min = 100)`; if `springdoc.customizer.examples.validate-examples` is set to `true`, then this example would be excluded from the OpenAPI specification because `intField` is invalid.\n\n### Specification Version\nOften times, it is helfpul to set the OpenAPI specification's version to the version of the Spring Boot project. By setting `springdoc.customizer.customize-version` to `true`, this will set the specification's version to the project's version.\n\n### Swagger UI\nThe Swagger UI is an incredibly powerful feature for any platforms which serve an OpenAPI specification. It allows for an interactive visualization of a REST service and is highly configurable. However, the webpage itself lacks support for customization\nwithout the use of raw JS which is undesireable for a Spring Boot project.\n\nWith springdoc-customizer, you can set the page's icon and title with a simple configuration. Simply set `springdoc.swagger-ui.title` and `springdoc.swagger-ui.large-icon-path`/`springdoc.swagger-ui.small-icon-path` values in your configuration to\ncustomize your page. Note that `large-icon-path` and `small-icon-path` must point to valid 32x32 and 16x16 images respectively within the `resources/static` folder.\n\n## Demo\nA demo project, [springdoc-customizer-webmvc-demo](https://github.com/funkyFangs/springdoc-customizer/tree/develop/springdoc-customizer-webmvc-demo), has been included to demonstrate available features.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunkyfangs%2Fspringdoc-customizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffunkyfangs%2Fspringdoc-customizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunkyfangs%2Fspringdoc-customizer/lists"}