Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Swagger #44

Merged
merged 1 commit into from
Dec 4, 2024
Merged

Add Swagger #44

merged 1 commit into from
Dec 4, 2024

Conversation

turchenkoalex
Copy link
Owner

@turchenkoalex turchenkoalex commented Nov 28, 2024

This pull request introduces the integration of Swagger UI into the project. The key changes include the addition of new files for Swagger UI setup, configuration, and resources, as well as modifications to the project configuration files to include Swagger UI as a module.

Swagger UI Integration:

Swagger UI Resources:

OpenAPI and Swagger Integration:

  • Added OpenAPI and Swagger UI options to the project configuration files (.idea/gradle.xml, gradle/libs.versions.toml). [1] [2] [3]
  • Created a new openapi module with necessary dependencies and build configurations (openapi/build.gradle.kts).
  • Implemented OpenAPI configuration and model classes to generate and serve OpenAPI JSON (openapi/src/main/kotlin/kotlet/openapi/OpenAPI.kt, openapi/src/main/kotlin/kotlet/openapi/OpenAPIConfig.kt, openapi/src/main/kotlin/kotlet/openapi/OpenAPIModel.kt, openapi/src/main/kotlin/kotlet/openapi/OpenAPIModelBuilder.kt, openapi/src/main/kotlin/kotlet/openapi/OpenAPIOperation.kt). [1] [2] [3] [4] [5]

Sample Application Updates:

  • Updated the sample application to include OpenAPI and Swagger UI dependencies (sample/build.gradle.kts).
  • Modified the main application file to install OpenAPI and Swagger UI endpoints, and removed redundant code (sample/src/main/kotlin/Main.kt). [1] [2] [3]

Copy link

Overall Project 81.55% 🍏

There is no coverage information present for the Files changed

Copy link

github-actions bot commented Dec 4, 2024

Overall Project 58.03% -28.86% 🍏
Files changed 0.3%

File Coverage
OpenAPIModelBuilder.kt 3.13% -96.88%
SwaggerUIConfig.kt 0%
SwaggerUI.kt 0%
OpenAPIOperation.kt 0%
OpenAPIConfig.kt 0%
OpenAPI.kt 0%
OpenAPIModel.kt 0%

Copy link

github-actions bot commented Dec 4, 2024

Overall Project 81.55% 🍏

There is no coverage information present for the Files changed

@turchenkoalex turchenkoalex merged commit e7bdf14 into main Dec 4, 2024
5 checks passed
@turchenkoalex turchenkoalex deleted the openapi-libs branch December 4, 2024 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant