{"id":20645002,"url":"https://github.com/romanow/openapi-aggregator-by-tags","last_synced_at":"2025-03-09T15:54:32.503Z","repository":{"id":178168594,"uuid":"660690925","full_name":"Romanow/openapi-aggregator-by-tags","owner":"Romanow","description":"Concatenate multiple OpenAPI in one file with Include and exclude tags","archived":false,"fork":false,"pushed_at":"2024-04-18T11:43:08.000Z","size":110,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-17T09:31:08.288Z","etag":null,"topics":["openapi","openapi-aggregraton","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","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/Romanow.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-06-30T15:40:48.000Z","updated_at":"2023-07-02T20:26:24.000Z","dependencies_parsed_at":"2024-04-18T12:43:02.814Z","dependency_job_id":"a4ac370d-9178-4eab-ad84-b15f59150d85","html_url":"https://github.com/Romanow/openapi-aggregator-by-tags","commit_stats":null,"previous_names":["romanow/openapi-aggregator-by-tags"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Fopenapi-aggregator-by-tags","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Fopenapi-aggregator-by-tags/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Fopenapi-aggregator-by-tags/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Fopenapi-aggregator-by-tags/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Romanow","download_url":"https://codeload.github.com/Romanow/openapi-aggregator-by-tags/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242714054,"owners_count":20173581,"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":["openapi","openapi-aggregraton","spring-boot"],"created_at":"2024-11-16T16:18:23.538Z","updated_at":"2025-03-09T15:54:32.482Z","avatar_url":"https://github.com/Romanow.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI aggregator by Tags\n\n[![Build project](https://github.com/Romanow/openapi-aggregator-by-tags/actions/workflows/build.yml/badge.svg)](https://github.com/Romanow/openapi-aggregator-by-tags/actions/workflows/build.yml)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n\nГенерация агрегированного OpenAPI по нескольким файлам:\n\n1. Если ничего не задано, то результатом будет конкатенированный OpenAPI.\n2. Если задан параметр `include`, то в результирующий OpenAPI добавляются только те path, для которых заданы _все_\n   переданные `tags`. Параметр `exclude` не учитывается.\n3. Если задан параметр `exclude`, то из всего множества `tags` удаляются те, что переданы в `exclude`.\n\nПри фильтрации результата используются следующий допущения:\n\n* Целевые `tags` строятся на базе блоке `tags` в верхнем уровне описания OpenAPI и к ним применяется\n  фильтрация `include`, `exclude`.\n* Метод добавляется в результирующий OpenAPI, если всего `tags` содержатся в целевых `tags`.\n* Если метод добавляется в результирующий OpenAPI, то его имена объектов request и response сохраняются и при\n  копировании схемы копируются только те объекты, на которые ссылались целевые методы.\n* Фильтрация выполняется только в блоке `schemas`, т.к. [springdoc](https://springdoc.org/) при генерации добавляет все\n  объекты туда, но не заполняет `headers`, `parameters`, `requestBodies`, `responses`.\n\n\u003e ⚠️ **Важное замечание**\n\u003e\n\u003e При генерации OpenAPI с правилами фильтрации _требуется перечитывать_ декларации OpenAPI из файла, т.к. при удалении\n\u003e метода он помечается `null`, а это влияет на `apis: Map\u003cString, OpenAPI\u003e`, который создается только один раз при\n\u003e инициализации приложения.\n\n## TODO\n\n* [ ] Запустить `openapi-aggregator-by-tags` в кластере.\n* [ ] Опубликовать OpenAPI как ConfigMap.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanow%2Fopenapi-aggregator-by-tags","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromanow%2Fopenapi-aggregator-by-tags","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanow%2Fopenapi-aggregator-by-tags/lists"}