{"id":36596490,"url":"https://github.com/opengood-aio/openapi-docs-autoconfig","last_synced_at":"2026-01-12T08:30:02.720Z","repository":{"id":40449041,"uuid":"227435475","full_name":"opengood-aio/openapi-docs-autoconfig","owner":"opengood-aio","description":"Spring Boot auto-configuration for OpenAPI documentation using Spring Doc","archived":false,"fork":false,"pushed_at":"2025-06-07T22:07:43.000Z","size":222,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-28T10:40:24.637Z","etag":null,"topics":["library","protected-branches-true","update-copyright-current-year"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opengood-aio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-12-11T18:41:02.000Z","updated_at":"2025-06-07T22:07:45.000Z","dependencies_parsed_at":"2025-04-20T23:25:04.210Z","dependency_job_id":"87127fd4-758f-4123-9e16-fc1655061f16","html_url":"https://github.com/opengood-aio/openapi-docs-autoconfig","commit_stats":null,"previous_names":["opengood-aio/openapi-docs-autoconfig","opengoodio/openapi-docs-autoconfig"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/opengood-aio/openapi-docs-autoconfig","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengood-aio%2Fopenapi-docs-autoconfig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengood-aio%2Fopenapi-docs-autoconfig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengood-aio%2Fopenapi-docs-autoconfig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengood-aio%2Fopenapi-docs-autoconfig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opengood-aio","download_url":"https://codeload.github.com/opengood-aio/openapi-docs-autoconfig/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opengood-aio%2Fopenapi-docs-autoconfig/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28337595,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["library","protected-branches-true","update-copyright-current-year"],"created_at":"2026-01-12T08:30:02.651Z","updated_at":"2026-01-12T08:30:02.711Z","avatar_url":"https://github.com/opengood-aio.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI Docs Auto Configuration\n\n[![Build](https://github.com/opengood-aio/openapi-docs-autoconfig/workflows/build/badge.svg)](https://github.com/opengood-aio/openapi-docs-autoconfig/actions?query=workflow%3Abuild)\n[![Release](https://github.com/opengood-aio/openapi-docs-autoconfig/workflows/release/badge.svg)](https://github.com/opengood-aio/openapi-docs-autoconfig/actions?query=workflow%3Arelease)\n[![CodeQL](https://github.com/opengood-aio/openapi-docs-autoconfig/actions/workflows/codeql.yml/badge.svg)](https://github.com/opengood-aio/openapi-docs-autoconfig/actions/workflows/codeql.yml)\n[![Codecov](https://codecov.io/gh/opengood-aio/openapi-docs-autoconfig/branch/main/graph/badge.svg?token=AEEYTGK87F)](https://codecov.io/gh/opengood-aio/openapi-docs-autoconfig)\n[![Release Version](https://img.shields.io/github/release/opengood-aio/openapi-docs-autoconfig.svg)](https://github.com/opengood-aio/openapi-docs-autoconfig/releases/latest)\n[![Maven Central](https://img.shields.io/maven-central/v/io.opengood.autoconfig/openapi-docs-autoconfig.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.opengood.autoconfig%22%20AND%20a:%22openapi-docs-autoconfig%22)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/opengood-aio/openapi-docs-autoconfig/master/LICENSE)\n\nSpring Boot auto-configuration for OpenAPI documentation using\n[Spring Doc](https://springdoc.org/)\n\n## Compatibility\n\n* Java 21\n* Spring Boot 3\n\n## Setup\n\n### Add Dependency\n\n#### Gradle\n\n```groovy\nimplementation(\"io.opengood.autoconfig:openapi-docs-autoconfig:VERSION\")\n```\n\n#### Maven\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.opengood.autoconfig\u003c/groupId\u003e\n    \u003cartifactId\u003eopenapi-docs-autoconfig\u003c/artifactId\u003e\n    \u003cversion\u003eVERSION\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n**Note:** See *Release* version badge above for latest version.\n\n## Configuration\n\nOpenAPI Docs Auto Configuration simplifies configuration using a\nYAML-based configuration approach.\n\n### Properties\n\n#### Main\n\n| Property           | Description                                                    | Default                     |\n|--------------------|----------------------------------------------------------------|-----------------------------|\n| `enabled`          | Value indicating if OpenAPI Docs auto configuration is enabled | `true`                      |\n| `paths`            | List of API resource paths to include in docs                  | `/**`                       |\n| `title`            | API title                                                      |                             |\n| `description`      | API description                                                |                             |\n| `version`          | API version                                                    |                             |\n| `terms-of-service` | API terms of service description                               |                             |\n| `contact`          | API contact details                                            | see *[Contact](#contact)*   |\n| `license`          | API license details                                            | see *[License](#license)*   |\n| `security`         | API security details                                           | see *[Security](#security)* |\n\n#### Contact\n\n| Property | Description               | Default |\n|----------|---------------------------|---------|\n| `name`   | API contact name          |         |\n| `url`    | API contact URL           |         |\n| `email`  | API contact email address |         |\n\n#### License\n\n| Property | Description      | Default |\n|----------|------------------|---------|\n| `name`   | API license name |         |\n| `url`    | API license URL  |         |\n\n#### Security\n\n| Property       | Description                                                                                       | Default                 |\n|----------------|---------------------------------------------------------------------------------------------------|-------------------------|\n| `enabled`      | Value indicating if OpenAPI Docs security is enabled                                              | `true`                  |\n| `name`         | API security name                                                                                 | `default`               |\n| `description`  | API security description                                                                          |                         |\n| `scheme`       | API security scheme. Supported values (`bearer`, `basic`)                                         | `basic`                 |\n| `type`         | API security type. Supported values (`http`, `apikey`)                                            | `http`                  |\n| `bearerFormat` | API security token bearer format. Supported values (`JWT`). Only required when `scheme = bearer`. | `JWT`                   |\n| `oauth2`       | API security OAuth2 details                                                                       | see *[OAuth2](#oauth2)* |\n\n#### OAuth2\n\n| Property     | Description                                                                    | Default                                   |\n|--------------|--------------------------------------------------------------------------------|-------------------------------------------|\n| `grant-type` | OAuth2 grant type. Supported values (`authorizationCode`, `clientCredentials`) | `authorizationCode`                       |\n| `token-uri`  | OAuth2 token URI                                                               | `http://localhost/oauth/token`            |\n| `resource`   | OAuth2 resource details                                                        | see *[OAuth2 Resource](#oauth2-resource)* |\n| `client`     | OAuth2 client details                                                          | see *[OAuth2 Client](#oauth2-client)*     |\n\n#### OAuth2 Resource\n\n| Property                   | Description                     | Default                            |\n|----------------------------|---------------------------------|------------------------------------|\n| `authorization-server-uri` | OAuth2 authorization server URI | `http://localhost/oauth/authorize` |\n\n#### OAuth2 Client\n\n| Property | Description                 | Default |\n|----------|-----------------------------|---------|\n| `scopes` | Map of OAuth2 client scopes |         |\n\n### Example\n\n```yaml\nopen-api-docs:\n  enabled: true\n  paths:\n    - /greeting/**\n  title: test title\n  description: test description\n  version: test version\n  terms-of-service: http://test.tos.url\n  contact:\n    name: test contact name\n    url: http://test.contact.url\n    email: test@domain.com\n  license:\n    name: test license name\n    url: http://test.lic.url\n  security:\n    enabled: true\n    name: test security\n    description: test security description\n    scheme: bearer\n    type: http\n    bearer-format: jwt\n    oauth2:\n      grant-type: clientCredentials\n      resource:\n        authorization-server-uri: http://localhost/oauth2/authorize\n      client:\n        scopes:\n          test-1: test-scope-1\n          test-2: test-scope-2\n      token-uri: http://localhost/oauth2/token\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopengood-aio%2Fopenapi-docs-autoconfig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopengood-aio%2Fopenapi-docs-autoconfig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopengood-aio%2Fopenapi-docs-autoconfig/lists"}