ePages-de / ePages-de/restdocs-api-spec

How to join documentation from multi-project build?

Open
#241 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
427
Forks
116
Avg merge
23h 54m
Merged PRs (30d)
1

Description

Sorry for using the issues for questions, but I did not find an answer myself. I may be missing something, or it may be a bug, so...

I tried to apply the project in a Gradle multi-project build, that contains subprojects with their own set of controllers. In Restdocs, the API documentation can be built by "joining" the snippets in the "generated-snippets" directories into one directory, and generating the documentation from there. While applying restdoc-api-spec works fine in each subproject, there does not seem a way to provide multiple JSON files as input. Manually joining them into one did not work. (Most likely because my crude hacks to achieve that were buggy.)

Is there a supported way to use restdoc-api-spec in a multi-project build? If now, what would be the general approach?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.