This project uses the swagger2markup-gradle-plugin to convert the Swagger specifications for Couchbase REST APIs into AsciiDoctor documentation.
This repository handles several Swagger subprojects.
Each subproject is stored in its own subfolder within the src
folder.
Within each subproject there is a gradle build script with a .gradle
extension.
The gradle build script specifies the locations of the Swagger source file, any additional AsciiDoc content, and the output AsciiDoc files.
The build.gradle
script in the root project folder calls the gradle build scripts from each subproject.
Some subprojects are not currently ready to be built. These do not have a gradle build script.
Within each subproject, the Swagger Specification (JSON or YAML) is stored in a folder called swagger
.
(For some subprojects, the Swagger specification file may be stored remotely, i.e. alongside the development source files.)
For each subproject, additional AsciiDoc content may be stored in the folder asciidoc/extensions
and its subfolders.
./gradlew project:convertSwagger2markup --rerun-tasks
Where project
is the subproject that you want to convert, for example, admin
.
This project is based on the Swagger2Markup Gradle template project.