From ada6740c7c81b5786c87d8e8de4a96f91762f42c Mon Sep 17 00:00:00 2001 From: Gyumin Bae Date: Wed, 26 Mar 2025 15:33:54 +0900 Subject: [PATCH 1/2] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 363b2c5..a54a73f 100644 --- a/README.md +++ b/README.md @@ -108,4 +108,7 @@ you can also create Postman collection by running the following command: ./gradlew postman ``` --- -[[click to see more sample code]](https://github.com/BGMSound/documentify/tree/main/documentify-sample) +[[click to see more sample code]](https://github.com/BGMSound/documentify/tree/main/documentify-sample) + +## Documentify Development Story +If you want to check out the development story of Documentify, please refer to the [blog post](https://bgmsound.medium.com/documentify-선언형-rest-docs-dsl-제작기-0a09f651be2c). From e827a0d1419b96c4766985d7f3b26ef831cf11c4 Mon Sep 17 00:00:00 2001 From: Gyumin Bae Date: Thu, 27 Mar 2025 22:23:26 +0900 Subject: [PATCH 2/2] Refactor project structure --- build.gradle.kts | 8 ++++---- documentify-project/build.gradle.kts | 4 +++- .../documentify-core}/build.gradle.kts | 4 ++-- .../documentify/core/emitter/AbstractDocumentEmitter.kt | 0 .../core/emitter/FieldJsonMatcherAssociater.kt | 0 .../core/emitter/SpecElementSampleAssociater.kt | 0 .../environment/AbstractDocumentContextEnvironment.kt | 0 .../environment/AbstractStandaloneContextEnvironment.kt | 0 .../core/environment/DocumentContextEnvironment.kt | 0 .../core/environment/StandaloneContextEnvironment.kt | 0 .../documentify/core/specification/DocumentableSpec.kt | 0 .../documentify/core/specification/FieldSchema.kt | 0 .../documentify/core/specification/ResourceSpec.kt | 0 .../documentify/core/specification/element/Link.kt | 0 .../documentify/core/specification/element/SpecElement.kt | 0 .../core/specification/element/field/DocsFieldType.kt | 0 .../documentify/core/specification/element/field/Field.kt | 0 .../core/specification/element/header/Header.kt | 0 .../core/specification/element/parameter/Parameter.kt | 0 .../core/specification/element/parameter/PathVariable.kt | 0 .../specification/element/parameter/QueryParameter.kt | 0 .../documentify/core/specification/schema/BodySpec.kt | 0 .../documentify/core/specification/schema/HeaderSpec.kt | 0 .../documentify/core/specification/schema/HttpSpec.kt | 0 .../documentify/core/specification/schema/Method.kt | 0 .../core/specification/schema/document/DocumentSpec.kt | 0 .../schema/document/ValidatelessResponseCaseContext.kt | 0 .../core/specification/schema/request/RequestBodySpec.kt | 0 .../specification/schema/request/RequestHeaderSpec.kt | 0 .../core/specification/schema/request/RequestLineSpec.kt | 0 .../core/specification/schema/request/RequestSpec.kt | 0 .../specification/schema/response/ResponseBodySpec.kt | 0 .../specification/schema/response/ResponseHeaderSpec.kt | 0 .../specification/schema/response/ResponseLineSpec.kt | 0 .../core/specification/schema/response/ResponseSpec.kt | 0 .../documentify-plugin}/build.gradle.kts | 0 .../bgmsound/documentify/plugin/DocumentifyPlugin.kt | 0 .../documentify/plugin/extensions/DocumentifyExtension.kt | 0 documentify-sample/build.gradle.kts | 2 +- documentify-starters/build.gradle.kts | 2 +- .../documentify-starter-mvc/build.gradle.kts | 2 +- .../documentify-starter-reactive/build.gradle.kts | 2 +- gradle.properties | 2 +- settings.gradle.kts | 4 ++-- 44 files changed, 16 insertions(+), 14 deletions(-) rename {documentify-core => documentify-project/documentify-core}/build.gradle.kts (73%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/AbstractDocumentEmitter.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/FieldJsonMatcherAssociater.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/SpecElementSampleAssociater.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractDocumentContextEnvironment.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractStandaloneContextEnvironment.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/environment/DocumentContextEnvironment.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/environment/StandaloneContextEnvironment.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/DocumentableSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/FieldSchema.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/ResourceSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/Link.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/SpecElement.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/DocsFieldType.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/Field.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/header/Header.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/Parameter.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/PathVariable.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/QueryParameter.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/BodySpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HeaderSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HttpSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/Method.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/DocumentSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/ValidatelessResponseCaseContext.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestBodySpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestHeaderSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestLineSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseBodySpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseHeaderSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseLineSpec.kt (100%) rename {documentify-core => documentify-project/documentify-core}/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseSpec.kt (100%) rename {documentify-plugin => documentify-project/documentify-plugin}/build.gradle.kts (100%) rename {documentify-plugin => documentify-project/documentify-plugin}/src/main/kotlin/io/github/bgmsound/documentify/plugin/DocumentifyPlugin.kt (100%) rename {documentify-plugin => documentify-project/documentify-plugin}/src/main/kotlin/io/github/bgmsound/documentify/plugin/extensions/DocumentifyExtension.kt (100%) diff --git a/build.gradle.kts b/build.gradle.kts index e0b0494..33e39e7 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -18,8 +18,8 @@ group = extra["project.group"] as String version = extra["project.version.id"] as String val publicModulePathSet = setOf( - rootProject.projects.documentifyCore.identityPath.path, - rootProject.projects.documentifyPlugin.identityPath.path, + rootProject.projects.documentifyProject.documentifyCore.identityPath.path, + rootProject.projects.documentifyProject.documentifyPlugin.identityPath.path, rootProject.projects.documentifyProject.documentifyMvc.identityPath.path, rootProject.projects.documentifyProject.documentifyReactive.identityPath.path, rootProject.projects.documentifyStarters.documentifyStarterMvc.identityPath.path, @@ -124,7 +124,7 @@ repositories { kover { merge { projects( - rootProject.projects.documentifyCore.identityPath.path, + rootProject.projects.documentifyProject.documentifyCore.identityPath.path, rootProject.projects.documentifyProject.documentifyMvc.identityPath.path, rootProject.projects.documentifyProject.documentifyReactive.identityPath.path, rootProject.projects.documentifySample.mvcSample.identityPath.path, @@ -136,4 +136,4 @@ kover { excludes.classes.add("**.sample.**") } } -} \ No newline at end of file +} diff --git a/documentify-project/build.gradle.kts b/documentify-project/build.gradle.kts index 6a1a744..aeaa9cb 100644 --- a/documentify-project/build.gradle.kts +++ b/documentify-project/build.gradle.kts @@ -4,6 +4,8 @@ subprojects { } dependencies { compileOnly(rootProject.libs.spring.boot.starter.test) - api(rootProject.projects.documentifyCore) + if (project.path != rootProject.projects.documentifyProject.documentifyCore.identityPath.path) { + api(rootProject.projects.documentifyProject.documentifyCore) + } } } \ No newline at end of file diff --git a/documentify-core/build.gradle.kts b/documentify-project/documentify-core/build.gradle.kts similarity index 73% rename from documentify-core/build.gradle.kts rename to documentify-project/documentify-core/build.gradle.kts index 97a8880..c3dc488 100644 --- a/documentify-core/build.gradle.kts +++ b/documentify-project/documentify-core/build.gradle.kts @@ -1,9 +1,9 @@ dependencies { implementation(libs.spring.boot.starter.test) implementation(libs.restdocs.api.spec) + implementation(libs.jackson.databind) + implementation(libs.jackson.datatype.jsr310) compileOnly(libs.spring.restdocs.mockmvc) compileOnly(libs.spring.boot.starter.web) compileOnly(libs.spring.boot.starter.webflux) - api(libs.jackson.databind) - api(libs.jackson.datatype.jsr310) } \ No newline at end of file diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/AbstractDocumentEmitter.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/AbstractDocumentEmitter.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/AbstractDocumentEmitter.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/AbstractDocumentEmitter.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/FieldJsonMatcherAssociater.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/FieldJsonMatcherAssociater.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/FieldJsonMatcherAssociater.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/FieldJsonMatcherAssociater.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/SpecElementSampleAssociater.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/SpecElementSampleAssociater.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/SpecElementSampleAssociater.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/SpecElementSampleAssociater.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractDocumentContextEnvironment.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractDocumentContextEnvironment.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractDocumentContextEnvironment.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractDocumentContextEnvironment.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractStandaloneContextEnvironment.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractStandaloneContextEnvironment.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractStandaloneContextEnvironment.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/AbstractStandaloneContextEnvironment.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/DocumentContextEnvironment.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/DocumentContextEnvironment.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/DocumentContextEnvironment.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/DocumentContextEnvironment.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/StandaloneContextEnvironment.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/StandaloneContextEnvironment.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/StandaloneContextEnvironment.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/environment/StandaloneContextEnvironment.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/DocumentableSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/DocumentableSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/DocumentableSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/DocumentableSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/FieldSchema.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/FieldSchema.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/FieldSchema.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/FieldSchema.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/ResourceSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/ResourceSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/ResourceSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/ResourceSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/Link.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/Link.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/Link.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/Link.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/SpecElement.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/SpecElement.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/SpecElement.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/SpecElement.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/DocsFieldType.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/DocsFieldType.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/DocsFieldType.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/DocsFieldType.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/Field.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/Field.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/Field.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/field/Field.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/header/Header.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/header/Header.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/header/Header.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/header/Header.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/Parameter.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/Parameter.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/Parameter.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/Parameter.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/PathVariable.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/PathVariable.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/PathVariable.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/PathVariable.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/QueryParameter.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/QueryParameter.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/QueryParameter.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/QueryParameter.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/BodySpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/BodySpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/BodySpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/BodySpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HeaderSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HeaderSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HeaderSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HeaderSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HttpSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HttpSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HttpSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/HttpSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/Method.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/Method.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/Method.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/Method.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/DocumentSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/DocumentSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/DocumentSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/DocumentSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/ValidatelessResponseCaseContext.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/ValidatelessResponseCaseContext.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/ValidatelessResponseCaseContext.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/ValidatelessResponseCaseContext.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestBodySpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestBodySpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestBodySpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestBodySpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestHeaderSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestHeaderSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestHeaderSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestHeaderSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestLineSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestLineSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestLineSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestLineSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/request/RequestSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseBodySpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseBodySpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseBodySpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseBodySpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseHeaderSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseHeaderSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseHeaderSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseHeaderSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseLineSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseLineSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseLineSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseLineSpec.kt diff --git a/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseSpec.kt similarity index 100% rename from documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseSpec.kt rename to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/response/ResponseSpec.kt diff --git a/documentify-plugin/build.gradle.kts b/documentify-project/documentify-plugin/build.gradle.kts similarity index 100% rename from documentify-plugin/build.gradle.kts rename to documentify-project/documentify-plugin/build.gradle.kts diff --git a/documentify-plugin/src/main/kotlin/io/github/bgmsound/documentify/plugin/DocumentifyPlugin.kt b/documentify-project/documentify-plugin/src/main/kotlin/io/github/bgmsound/documentify/plugin/DocumentifyPlugin.kt similarity index 100% rename from documentify-plugin/src/main/kotlin/io/github/bgmsound/documentify/plugin/DocumentifyPlugin.kt rename to documentify-project/documentify-plugin/src/main/kotlin/io/github/bgmsound/documentify/plugin/DocumentifyPlugin.kt diff --git a/documentify-plugin/src/main/kotlin/io/github/bgmsound/documentify/plugin/extensions/DocumentifyExtension.kt b/documentify-project/documentify-plugin/src/main/kotlin/io/github/bgmsound/documentify/plugin/extensions/DocumentifyExtension.kt similarity index 100% rename from documentify-plugin/src/main/kotlin/io/github/bgmsound/documentify/plugin/extensions/DocumentifyExtension.kt rename to documentify-project/documentify-plugin/src/main/kotlin/io/github/bgmsound/documentify/plugin/extensions/DocumentifyExtension.kt diff --git a/documentify-sample/build.gradle.kts b/documentify-sample/build.gradle.kts index a6f46b6..40938e6 100644 --- a/documentify-sample/build.gradle.kts +++ b/documentify-sample/build.gradle.kts @@ -1,5 +1,5 @@ plugins { - id("io.github.bgmsound.documentify") version "1.0.0" apply false + id("io.github.bgmsound.documentify") version "1.2.4" apply false } subprojects { diff --git a/documentify-starters/build.gradle.kts b/documentify-starters/build.gradle.kts index 29502b7..3028c0b 100644 --- a/documentify-starters/build.gradle.kts +++ b/documentify-starters/build.gradle.kts @@ -8,6 +8,6 @@ subprojects { } dependencies { compileOnly(rootProject.libs.spring.boot.starter.test) - api(rootProject.projects.documentifyCore) + api(rootProject.projects.documentifyProject.documentifyCore) } } \ No newline at end of file diff --git a/documentify-starters/documentify-starter-mvc/build.gradle.kts b/documentify-starters/documentify-starter-mvc/build.gradle.kts index 9181dce..6dfce7b 100644 --- a/documentify-starters/documentify-starter-mvc/build.gradle.kts +++ b/documentify-starters/documentify-starter-mvc/build.gradle.kts @@ -1,5 +1,5 @@ dependencies { - api(projects.documentifyCore) + api(projects.documentifyProject.documentifyCore) api(projects.documentifyProject.documentifyMvc) api(libs.spring.restdocs.mockmvc) api(libs.spring.restdocs.restassured) diff --git a/documentify-starters/documentify-starter-reactive/build.gradle.kts b/documentify-starters/documentify-starter-reactive/build.gradle.kts index 182fe46..c86d46c 100644 --- a/documentify-starters/documentify-starter-reactive/build.gradle.kts +++ b/documentify-starters/documentify-starter-reactive/build.gradle.kts @@ -1,5 +1,5 @@ dependencies { - api(projects.documentifyCore) + api(projects.documentifyProject.documentifyCore) api(projects.documentifyProject.documentifyReactive) api(libs.spring.restdocs.webtestclient) api(libs.restdocs.api.spec) diff --git a/gradle.properties b/gradle.properties index 1633220..f23c2a9 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,7 +1,7 @@ project.name=documentify project.group=io.github.bgmsound -project.version.id=1.2.4 +project.version.id=1.2.5 project.artifact=documentify project.description=Documentify is a tool to generate API documentation from source code. diff --git a/settings.gradle.kts b/settings.gradle.kts index f63d2cd..0079e46 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -11,9 +11,9 @@ plugins { id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" } -include("documentify-core") -include("documentify-plugin") include("documentify-project") +include("documentify-project:documentify-core") +include("documentify-project:documentify-plugin") include("documentify-project:documentify-mvc") include("documentify-project:documentify-reactive") include("documentify-sample")